Fix sample configuration Change-Id: Ie985242e3aa43fec8d2fe91925b87175a926bb70
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index 669b838..b7843a4 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -29,15 +29,21 @@ Example: - [commentLink "Bugzilla"] - match = (\\([Bb][Uu][Gg][ ]*[1-9][0-9]*\\)) - html = "<a href=\"http://mybugzilla.org/show_bug.cgi?id=$1\">$1</a>" + [commentLink "bugzilla"] + match = \\([Bb][Uu][Gg][ ]*([1-9][0-9]*)\\) + html = "<a href=\"http://mybugzilla.org/show_bug.cgi?id=$1\">(bug $1)</a>" association = SUGGESTED Once a Git commit with a comment link is detected, the Bugzilla bug ID is extracted and a new comment added to the issue, pointing back to the original Git commit. +Note that the plugin relies on $1 holding the numeric id, so we cannot +have match group 1 spanning over the whole “(Bug 4711)”. + +Be sure to label the commentLink “bugzilla” with lowercase “b” to +match the config section's name below. + Bugzilla connectivity --------------------- @@ -49,7 +55,7 @@ [bugzilla] url=http://mybugzilla.org username=bzuser - passsword=bzpass + password=bzpass Bugzilla credentials and connectivity details are asked and verified during the Gerrit init.