Merge "Fix the location of the issue-state-transition.config in the docs"
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
index 93e0774..20481e3 100644
--- a/src/main/resources/Documentation/config.md
+++ b/src/main/resources/Documentation/config.md
@@ -24,14 +24,14 @@
a warning message is displayed as a suggestion on the client.
OPTIONAL
-: Issues-ids are liked when found on git commit message, no warning are
+: Issues-ids are linked when found on git commit message, no warnings are
displayed otherwise.
Example:
[commentLink "Jira"]
match = (\\[[A-Z][A-Z]+-[1-9][0-9]*\\])
- html = "<a href=\"http://myjira.com/browse/$1\">$1</a>"
+ html = "<a href=\"http://jira.example.com/browse/$1\">$1</a>"
association = SUGGESTED
Once a Git commit with a comment link is detected, the Jira issue ID
@@ -47,12 +47,51 @@
Example:
[jira]
- url=http://myjira.com
- username=jirauser
- passsword=jirapass
+ url=http://jira.example.com
+ username=admin
+ password=jirapass
Jira credentials and connectivity details are asked and verified during the Gerrit init.
+Comment configuration
+---------------------
+
+It is possible to choose which kind of Gerrit event will trigger the plugin to comment on
+the Jira issue by adding the following in your gerrit.config file under the [jira] section:
+
+commentOnChangeAbandoned
+: If true, abandoning a change adds a comment to the issue.
+
+commentOnChangeCreated
+: If true, creating a change adds a comment to the issue.
+
+commentOnChangeMerged
+: If true, merging a change adds a comment to the issue.
+
+commentOnChangeRestored
+: If true, restoring an abandoned change adds a comment to the issue.
+
+commentOnCommentAdded
+: If true, adding a comment or reviewing a change adds a comment to the issue.
+
+commentOnFirstLinkedPatchSetCreated
+: If true, creating a patch set for a change adds a comment to the issue if
+ the issue has not been mentioned in previous patch sets of the same change.
+
+commentOnPatchSetCreated
+: If true, creating a patch set for a change adds a comment to the issue.
+
+commentOnRefUpdatedGitWeb
+: If true, updating a ref adds a comment to the issue.
+
+By default they are set to true
+
+Example:
+
+ [jira]
+ commentOnCommentAdded=false
+ commentOnRefUpdatedGitWeb=false
+
Gerrit init integration
-----------------------
@@ -65,12 +104,12 @@
*** Jira connectivity
***
- Jira URL (empty to skip) [http://jira.lmitsoftware.com]:
+ Jira URL (empty to skip) [http://jira.example.com]:
Jira username [admin]:
Change admin's password [y/N]? y
admin's password : *****
confirm password : *****
- Test connectivity to http://jira.lmitsoftware.com [N/?]: y
+ Test connectivity to http://jira.example.com [N/?]: y
Checking Jira connectivity ... [OK]
*** Jira issue-tracking association
@@ -141,4 +180,4 @@
* Whenever a new Change-set is created on Gerrit, start progress on the Jira issue
* Whenever a change is verified and reviewed with +2, transition the Jira issue to resolved
* Whenever a change is merged to branch, mark the Jira transition the Jira issue to closed
-* Whenever a change is abandoned, stop the progress on Jira issue
\ No newline at end of file
+* Whenever a change is abandoned, stop the progress on Jira issue
