debian-mirror-gitlab/doc/administration/issue_closing_pattern.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

2016-09-29 09:46:39 +05:30
# Issue closing pattern
>**Note:**
This is the administration documentation.
There is a separate [user documentation] on issue closing pattern.
When a commit or merge request resolves one or more issues, it is possible to
automatically have these issues closed when the commit or merge request lands
in the project's default branch.
## Change the issue closing pattern
In order to change the pattern you need to have access to the server that GitLab
is installed on.
The default pattern can be located in [gitlab.yml.example] under the
"Automatic issue closing" section.
> **Tip:**
2019-03-02 22:35:43 +05:30
You are advised to use <http://rubular.com> to test the issue closing pattern.
2016-09-29 09:46:39 +05:30
Because Rubular doesn't understand `%{issue_ref}`, you can replace this by
`#\d+` when testing your patterns, which matches only local issue references like `#123`.
**For Omnibus installations**
1. Open `/etc/gitlab/gitlab.rb` with your editor.
2018-05-09 12:01:36 +05:30
1. Change the value of `gitlab_rails['gitlab_issue_closing_pattern']` to a regular
2016-09-29 09:46:39 +05:30
expression of your liking:
```ruby
2018-11-20 20:47:30 +05:30
gitlab_rails['gitlab_issue_closing_pattern'] = "\b((?:[Cc]los(?:e[sd]|ing)|\b[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?%{issue_ref}(?:(?:, *| +and +)?))+)"
2016-09-29 09:46:39 +05:30
```
1. [Reconfigure] GitLab for the changes to take effect.
**For installations from source**
1. Open `gitlab.yml` with your editor.
1. Change the value of `issue_closing_pattern`:
```yaml
2018-11-20 20:47:30 +05:30
issue_closing_pattern: "\b((?:[Cc]los(?:e[sd]|ing)|\b[Ff]ix(?:e[sd]|ing)?) +(?:(?:issues? +)?%{issue_ref}(?:(?:, *| +and +)?))+)"
2016-09-29 09:46:39 +05:30
```
1. [Restart] GitLab for the changes to take effect.
[gitlab.yml.example]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example
[reconfigure]: restart_gitlab.md#omnibus-gitlab-reconfigure
[restart]: restart_gitlab.md#installations-from-source
[user documentation]: ../user/project/issues/automatic_issue_closing.md