##// END OF EJS Templates
docs: improve issue tracker integration docs
Andrew Shadura -
r4848:570a4e40 default
parent child Browse files
Show More
1 NO CONTENT: modified file chmod 100755 => 100644
@@ -447,17 +447,33 b' uncomment following variables in the ini'
447 447 issue_server_link = https://myissueserver.com/{repo}/issue/{id}
448 448 issue_prefix = #
449 449
450 `issue_pat` is the regular expression that will fetch issues from commit messages.
451 Default regex will match issues in format of #<number> eg. #300.
450 `issue_pat` is the regular expression describing which strings in
451 commit messages will be treated as issue references. A match group in
452 parentheses should be used to specify the actual issue id.
453
454 The default expression matches issues in the format '#<number>', e.g. '#300'.
452 455
453 Matched issues will be replace with the link specified as `issue_server_link`
454 {id} will be replaced with issue id, and {repo} with repository name.
455 Since the # is striped `issue_prefix` is added as a prefix to url.
456 `issue_prefix` can be something different than # if you pass
457 ISSUE- as issue prefix this will generate an url in format::
456 Matched issues are replaced with the link specified as `issue_server_link`
457 {id} is replaced with issue id, and {repo} with repository name.
458 Since the # is stripped away, `issue_prefix` is prepended to the link text.
459 `issue_prefix` doesn't necessarily need to be #: if you set issue
460 prefix to ISSUE- this will generate a URL in format::
458 461
459 462 <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>
460 463
464 If needed, more than one pattern can be specified by appending a unique suffix to
465 the variables. For example::
466
467 issue_pat_wiki = (?:wiki-)(.+)
468 issue_server_link_wiki = https://mywiki.com/{id}
469 issue_prefix_wiki = WIKI-
470
471 With these settings, wiki pages can be referenced as wiki-some-id, and every
472 such reference will be transformed into::
473
474 <a href="https://mywiki.com/some-id">WIKI-some-id</a>
475
476
461 477 Hook management
462 478 ---------------
463 479
General Comments 0
You need to be logged in to leave comments. Login now