kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/administration/issue_closing_pattern.md

53 lines
2.2 KiB
Markdown
Raw Normal View History

Add latest changes from gitlab-org/gitlab@master
2020-07-29 12:09:45 +00:00
---
stage: Create
group: Source Code
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers"
type: reference
---
Changing badges to use parentheses not brackets Previously, we used brackets to denote the tier badges, but this made Kramdown, the docs site Markdown renderer, show many warnings when building the site. This is now fixed by using parentheses instead of square brackets. This was caused by [PREMIUM] looking like a link to Kramdown, which couldn't find a URL there. See: - https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484 - https://gitlab.com/gitlab-org/gitlab-ce/issues/63800
2019-07-08 08:50:38 +00:00
# Issue closing pattern **(CORE ONLY)**
Change location and refactor issue closing pattern documentation Split into user and administrator docs: - administration/issue_closing_pattern.md - user/project/issues/automatic_issue_closing.md [ci skip]
2016-09-21 11:01:48 +00:00
Add latest changes from gitlab-org/gitlab@master
2020-07-23 18:10:06 +00:00
NOTE: **Note:**
Add backticks and remove square brackets Square and Angle bracket use causes kramdown warnings, so changed or enclosed in backticks as needed
2019-08-26 20:17:51 +00:00
This is the administration documentation. There is a separate [user documentation](../user/project/issues/managing_issues.md#closing-issues-automatically)
on issue closing pattern.
Change location and refactor issue closing pattern documentation Split into user and administrator docs: - administration/issue_closing_pattern.md - user/project/issues/automatic_issue_closing.md [ci skip]
2016-09-21 11:01:48 +00:00
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.
Add latest changes from gitlab-org/gitlab@master
2019-09-18 18:06:14 +00:00
The default pattern can be located in [`gitlab.yml.example`](https://gitlab.com/gitlab-org/gitlab/blob/master/config/gitlab.yml.example)
Add backticks and remove square brackets Square and Angle bracket use causes kramdown warnings, so changed or enclosed in backticks as needed
2019-08-26 20:17:51 +00:00
under the "Automatic issue closing" section.
Change location and refactor issue closing pattern documentation Split into user and administrator docs: - administration/issue_closing_pattern.md - user/project/issues/automatic_issue_closing.md [ci skip]
2016-09-21 11:01:48 +00:00
Add latest changes from gitlab-org/gitlab@master
2020-07-23 18:10:06 +00:00
TIP: **Tip:**
Add latest changes from gitlab-org/gitlab@master
2019-10-08 03:05:52 +00:00
You are advised to use <https://rubular.com> to test the issue closing pattern.
Change location and refactor issue closing pattern documentation Split into user and administrator docs: - administration/issue_closing_pattern.md - user/project/issues/automatic_issue_closing.md [ci skip]
2016-09-21 11:01:48 +00:00
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.
Fix typo in issue closing pattern docs
2018-03-29 11:38:09 +00:00
1. Change the value of `gitlab_rails['gitlab_issue_closing_pattern']` to a regular
Change location and refactor issue closing pattern documentation Split into user and administrator docs: - administration/issue_closing_pattern.md - user/project/issues/automatic_issue_closing.md [ci skip]
2016-09-21 11:01:48 +00:00
expression of your liking:
Fix spacing of code blocks Code blocks should not be spaced 4 times, as this will prevent the code from being colored. They should also be spaced the same as the lists they are a part of, to make reading easier.
2019-07-09 07:16:17 +00:00
```ruby
Add latest changes from gitlab-org/gitlab@master
2020-04-21 15:21:10 +00:00
gitlab_rails['gitlab_issue_closing_pattern'] = "\b((?:[Cc]los(?:e[sd]?|ing)|\b[Ff]ix(?:e[sd]|ing)?|\b[Rr]esolv(?:e[sd]?|ing)|\b[Ii]mplement(?:s|ed|ing)?)(:?) +(?:(?:issues? +)?%{issue_ref}(?:(?: *,? +and +| *,? *)?)|([A-Z][A-Z0-9_]+-\d+))+)"
Fix spacing of code blocks Code blocks should not be spaced 4 times, as this will prevent the code from being colored. They should also be spaced the same as the lists they are a part of, to make reading easier.
2019-07-09 07:16:17 +00:00
```
Add backticks and remove square brackets Square and Angle bracket use causes kramdown warnings, so changed or enclosed in backticks as needed
2019-08-26 20:17:51 +00:00
1. [Reconfigure](restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect.
Change location and refactor issue closing pattern documentation Split into user and administrator docs: - administration/issue_closing_pattern.md - user/project/issues/automatic_issue_closing.md [ci skip]
2016-09-21 11:01:48 +00:00
**For installations from source**
1. Open `gitlab.yml` with your editor.
1. Change the value of `issue_closing_pattern`:
Fix spacing of code blocks Code blocks should not be spaced 4 times, as this will prevent the code from being colored. They should also be spaced the same as the lists they are a part of, to make reading easier.
2019-07-09 07:16:17 +00:00
```yaml
Add latest changes from gitlab-org/gitlab@master
2020-04-21 15:21:10 +00:00
issue_closing_pattern: "\b((?:[Cc]los(?:e[sd]?|ing)|\b[Ff]ix(?:e[sd]|ing)?|\b[Rr]esolv(?:e[sd]?|ing)|\b[Ii]mplement(?:s|ed|ing)?)(:?) +(?:(?:issues? +)?%{issue_ref}(?:(?: *,? +and +| *,? *)?)|([A-Z][A-Z0-9_]+-\d+))+)"
Fix spacing of code blocks Code blocks should not be spaced 4 times, as this will prevent the code from being colored. They should also be spaced the same as the lists they are a part of, to make reading easier.
2019-07-09 07:16:17 +00:00
```
Change location and refactor issue closing pattern documentation Split into user and administrator docs: - administration/issue_closing_pattern.md - user/project/issues/automatic_issue_closing.md [ci skip]
2016-09-21 11:01:48 +00:00
Add backticks and remove square brackets Square and Angle bracket use causes kramdown warnings, so changed or enclosed in backticks as needed
2019-08-26 20:17:51 +00:00
1. [Restart](restart_gitlab.md#installations-from-source) GitLab for the changes to take effect.