| Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 1 | = Gerrit Code Review - Stars |
| 2 | |
| 3 | == Description |
| 4 | |
| 5 | Changes can be starred with labels that behave like private hashtags. |
| 6 | Any label can be applied to a change, but these labels are only visible |
| 7 | to the user for which the labels have been set. |
| 8 | |
| 9 | Stars allow users to categorize changes by self-defined criteria and |
| 10 | then build link:user-dashboards.html[dashboards] for them by making use |
| 11 | of the link:#query-stars[star query operators]. |
| 12 | |
| 13 | [[star-api]] |
| 14 | == Star API |
| 15 | |
| 16 | The link:rest-api-accounts.html#star-endpoints[star REST API] supports: |
| 17 | |
| 18 | * link:rest-api-accounts.html#get-stars[ |
| 19 | get star labels from a change] |
| 20 | * link:rest-api-accounts.html#set-stars[ |
| 21 | update star labels on a change] |
| 22 | * link:rest-api-accounts.html#get-starred-changes[ |
| 23 | list changes that are starred by any label] |
| 24 | |
| 25 | Star labels are also included in |
| 26 | link:rest-api-changes.html#change-info[ChangeInfo] entities that are |
| 27 | returned by the link:rest-api-changes.html[changes REST API]. |
| 28 | |
| 29 | There are link:rest-api-accounts.html#default-star-endpoints[ |
| 30 | additional REST endpoints] for the link:#default-star[default star]. |
| 31 | |
| Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 32 | [[default-star]] |
| 33 | == Default Star |
| 34 | |
| 35 | If the default star is set by a user, this user is automatically |
| 36 | notified by email whenever updates are made to that change. |
| 37 | |
| 38 | The default star is the star that is shown in the WebUI and which can |
| 39 | be updated from there. |
| 40 | |
| 41 | The default star is represented by the special star label 'star'. |
| 42 | |
| Edwin Kempin | 7770430 | 2016-04-19 13:47:19 +0200 | [diff] [blame] | 43 | [[ignore-star]] |
| 44 | == Ignore Star |
| 45 | |
| 46 | If the ignore star is set by a user, this user gets no email |
| 47 | notifications for updates of that change, even if this user is a |
| 48 | reviewer of the change or the change is matched by a project watch of |
| 49 | the user. |
| 50 | |
| 51 | Since changes can only be ignored once they are created, users that |
| 52 | watch a project will always get the email notifications for the change |
| 53 | creation. Only then the change can be ignored. |
| 54 | |
| Edwin Kempin | 5822cb3 | 2017-03-10 10:52:04 +0100 | [diff] [blame] | 55 | Users that are added as reviewer or assignee to a change that they have |
| 56 | ignored will be notified about this, so that they know about the review |
| 57 | request. They can then decide to remove the ignore star. |
| Edwin Kempin | 7770430 | 2016-04-19 13:47:19 +0200 | [diff] [blame] | 58 | |
| 59 | The ignore star is represented by the special star label 'ignore'. |
| 60 | |
| Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 61 | [[query-stars]] |
| 62 | == Query Stars |
| 63 | |
| 64 | There are several query operators to find changes with stars: |
| 65 | |
| Edwin Kempin | 9e972cc | 2016-04-15 10:39:13 +0200 | [diff] [blame] | 66 | * link:user-search.html#is-starred[is:starred] / |
| 67 | link:user-search.html#has-star[has:star]: |
| 68 | Matches any change that was starred by the current user with the |
| 69 | link:#default-star[default star]. |
| 70 | |
| 71 | [[syntax]] |
| 72 | == Syntax |
| 73 | |
| 74 | Star labels cannot contain whitespace characters. All other characters |
| 75 | are allowed. |
| 76 | |
| 77 | GERRIT |
| 78 | ------ |
| 79 | Part of link:index.html[Gerrit Code Review] |
| 80 | |
| 81 | SEARCHBOX |
| 82 | --------- |
