opendev/gerrit
Code Issues Proposed changes

Documentation: improve Verified label configuation section

Browse Source 
* Adjust documentation to state that the Code-Review label is the only
  actual default configured label.
* Add `copyAllScoresIfNoCodeChange = true` to example Verified label
  configuration to mimick what the InitLabels InitStep would configure.

Change-Id: I37a56c38cffca7bbc6e7c6c2bf7ef68ee5596238
This commit is contained in:
Gert van Dijk 2017-08-28 01:30:47 +02:00 committed by David Pursehouse
parent cb0f62fd95
commit bc683f2f2d
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/config-labels.txt
View File

@ -11,11 +11,10 @@ groups within projects, enabling functionality for that group's members.
[[label_Code-Review]]
== Label: Code-Review
The code review label is the second of two default labels that is
configured upon the creation of a Gerrit instance. It may have any
meaning the project desires. It was originally invented by the Android
Open Source Project to mean 'I read the code and it seems reasonably
correct'.
The Code-Review label is configured upon the creation of a Gerrit
instance. It may have any meaning the project desires. It was
originally invented by the Android Open Source Project to mean
'I read the code and it seems reasonably correct'.
The range of values is:
@ -87,8 +86,10 @@ The Verified label was originally invented by the Android Open Source
Project to mean 'compiles, passes basic unit tests'. Some CI tools
expect to use the Verified label to vote on a change after running.
Administrators can install the Verified label by adding the following
text to `project.config`:
During site initialization the administrator may have chosen to
configure the default Verified label for all projects. In case it is
desired to configure it at a later time, administrators can do this by
adding the following to `project.config` in `All-Projects`:
----
[label "Verified"]
@ -96,6 +97,7 @@ text to `project.config`:
value = -1 Fails
value = 0 No score
value = +1 Verified
copyAllScoresIfNoCodeChange = true
----
The range of values is:
@ -315,8 +317,8 @@ set and the same code delta as the previous patch set. This means only
the commit message is different. This can be used to enable sticky
approvals on labels that only depend on the code, reducing turn-around
if only the commit message is changed prior to submitting a change.
For the Verified label that is installed by the link:pgm-init.html[init]
site program this is enabled by default.
For the Verified label that is optionally installed by the
link:pgm-init.html[init] site program this is enabled by default.
Defaults to false.