diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2015-03-31 06:50:59 +0000 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2015-03-31 06:50:59 +0000 |
| commit | 28e5c42f809c342d57150a96b7b978c9e5b2b0f4 (patch) | |
| tree | 83600c0b021e944f06893a7b8e564ecf074ecb62 | |
| parent | 0191857fac465fbfb4acad1b923c29f3b05529aa (diff) | |
| parent | 7a02b5c20cdada26ceb256fd83c9df8c9bc32298 (diff) | |
| download | gitlab-ce-28e5c42f809c342d57150a96b7b978c9e5b2b0f4.tar.gz | |
Merge branch 'doc_issue_closing' into 'master'
Update documentation on issue closing pattern.
See merge request !475
| -rw-r--r-- | config/gitlab.yml.example | 4 | ||||
| -rw-r--r-- | doc/customization/issue_closing.md | 35 |
2 files changed, 35 insertions, 4 deletions
diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example index 3f1ca34a667..760a589d6e2 100644 --- a/config/gitlab.yml.example +++ b/config/gitlab.yml.example @@ -66,8 +66,8 @@ production: &base # If a commit message matches this regular expression, all issues referenced from the matched text will be closed. # This happens when the commit is pushed or merged into the default branch of a project. # When not specified the default issue_closing_pattern as specified below will be used. - # Tip: you can test your closing pattern at http://rubular.com - # issue_closing_pattern: '((?:[Cc]los(?:e[sd]|ing)|[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?#\d+(?:(?:, *| +and +)?))+)' + # Tip: you can test your closing pattern at http://rubular.com. + # issue_closing_pattern: '((?:[Cc]los(?:e[sd]?|ing)|[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?#\d+(?:(?:, *| +and +)?))+)' ## Default project features settings default_projects_features: diff --git a/doc/customization/issue_closing.md b/doc/customization/issue_closing.md index ddc0c8eac2b..aa65a082a53 100644 --- a/doc/customization/issue_closing.md +++ b/doc/customization/issue_closing.md @@ -1,5 +1,36 @@ # Issue closing pattern -By default you can close issues from commit messages by saying 'Closes #12' or 'Fixed #101'. +If a commit message matches the regular expression below, all issues referenced from +the matched text will be closed. This happens when the commit is pushed or merged +into the default branch of a project. -If you want to customize the message please do so in [gitlab.yml](https://gitlab.com/gitlab-org/gitlab-ce/blob/73b92f85bcd6c213b845cc997843a969cf0906cf/config/gitlab.yml.example#L73) +When not specified, the default issue_closing_pattern as shown below will be used: + +```bash +((?:[Cc]los(?:e[sd]?|ing)|[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?#\d+(?:(?:, *| +and +)?))+) +``` + +For example: + +``` +git commit -m "Awesome commit message (Fix #20, Fixes #21 and Closes #22). This commit is also related to #17 and fixes #18, #19 and #23." +``` + +will close `#20`, `#21`, `#22`, `#18`, `#19` and `#23`, but `#17` won't be closed +as it does not match the pattern. It also works with multiline commit messages. + +Tip: you can test this closing pattern at [http://rubular.com][1]. Use this site +to test your own patterns. + +## Change the pattern + +For Omnibus installs you can change the default pattern in `/etc/gitlab/gitlab.rb`: + +``` +issue_closing_pattern: '((?:[Cc]los(?:e[sd]|ing)|[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?#\d+(?:(?:, *| +and +)?))+)' +``` + +For manual installs you can customize the pattern in [gitlab.yml][0]. + +[0]: https://gitlab.com/gitlab-org/gitlab-ce/blob/40c3675372320febf5264061c9bcd63db2dfd13c/config/gitlab.yml.example#L65 +[1]: http://rubular.com/r/Xmbexed1OJ |