opendev/gerrit
Code Issues Proposed changes

Document "autogenerated:" prefix for REST robot comments

Browse Source 
Bug: Issue 6357
Change-Id: I00f0c53b73293d33135e14cd2878624fb877085f
This commit is contained in:
Vitaliy Lotorev
2018-06-28 20:16:39 +00:00
committed by Sven Selberg
parent fca464cb3a
commit 183383a3ba
2 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/cmd-review.txt
View File

@@ -129,8 +129,8 @@ branch.
-t:: -t::
Apply a 'TAG' to the change message, votes, and inline comments. The 'TAG' Apply a 'TAG' to the change message, votes, and inline comments. The 'TAG'
can represent an external system like CI that does automated verification can represent an external system like CI that does automated verification
of the change. Comments with specific 'TAG' values can be filtered out in of the change. Comments that contain TAG values with 'autogenerated:' prefix
the web UI. can be filtered out in the web UI.
Note that to apply different tags on different votes/comments, multiple Note that to apply different tags on different votes/comments, multiple
invocations of the SSH command are required. invocations of the SSH command are required.

13
Documentation/rest-api-changes.txt
View File

@@ -5544,7 +5544,8 @@ on that label.
The time and date describing when the approval was made. The time and date describing when the approval was made.
|`tag` |optional| |`tag` |optional|
Value of the `tag` field from link:#review-input[ReviewInput] set Value of the `tag` field from link:#review-input[ReviewInput] set
while posting the review. while posting the review. Votes/comments that contain `tag` with
'autogenerated:' prefix can be filtered out in the web UI.
NOTE: To apply different tags on different votes/comments multiple NOTE: To apply different tags on different votes/comments multiple
invocations of the REST call are required. invocations of the REST call are required.
|`post_submit` |not set if `false`| |`post_submit` |not set if `false`|
@@ -5800,7 +5801,8 @@ The link:rest-api.html#timestamp[timestamp] this message was posted.
|`message` ||The text left by the user. |`message` ||The text left by the user.
|`tag` |optional| |`tag` |optional|
Value of the `tag` field from link:#review-input[ReviewInput] set Value of the `tag` field from link:#review-input[ReviewInput] set
while posting the review. while posting the review. Votes/comments that contain `tag` with
'autogenerated:' prefix can be filtered out in the web UI.
NOTE: To apply different tags on different votes/comments multiple NOTE: To apply different tags on different votes/comments multiple
invocations of the REST call are required. invocations of the REST call are required.
|`_revision_number` |optional| |`_revision_number` |optional|
@@ -5921,7 +5923,8 @@ comment is deleted.
|`tag` |optional, drafts only| |`tag` |optional, drafts only|
Value of the `tag` field. Only allowed on link:#create-draft[draft comment] + Value of the `tag` field. Only allowed on link:#create-draft[draft comment] +
inputs; for published comments, use the `tag` field in + inputs; for published comments, use the `tag` field in +
link#review-input[ReviewInput] link#review-input[ReviewInput]. Votes/comments that contain `tag` with
'autogenerated:' prefix can be filtered out in the web UI.
|`unresolved` |optional| |`unresolved` |optional|
Whether or not the comment must be addressed by the user. This value will Whether or not the comment must be addressed by the user. This value will
default to false if the comment is an orphan, or the value of the `in_reply_to` default to false if the comment is an orphan, or the value of the `in_reply_to`
@@ -6689,8 +6692,8 @@ The message to be added as review comment.
|`tag` |optional| |`tag` |optional|
Apply this tag to the review comment message, votes, and inline Apply this tag to the review comment message, votes, and inline
comments. Tags may be used by CI or other automated systems to comments. Tags may be used by CI or other automated systems to
distinguish them from human reviews. Comments with specific tag distinguish them from human reviews. Votes/comments that contain `tag` with
values can be filtered out in the web UI. 'autogenerated:' prefix can be filtered out in the web UI.
|`labels` |optional| |`labels` |optional|
The votes that should be added to the revision as a map that maps the The votes that should be added to the revision as a map that maps the
label names to the voting values. label names to the voting values.