3.0 KiB
stage, group, info, description, title
stage | group | info | description | title |
---|---|---|---|---|
Create | Code Review | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Instance administrators can configure a custom issue closing pattern for their GitLab instance. | Issue closing pattern |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
{{< alert type="note" >}}
For user documentation about issue closing patterns, see Closing issues automatically.
{{< /alert >}}
When a commit or merge request resolves one or more issues, GitLab can close those issues when the commit or merge request lands in the project's default branch. The default issue closing pattern covers a wide range of words, and administrators can configure the word list as needed.
Change the issue closing pattern
To change the default issue closing pattern to suit your needs:
{{< tabs >}}
{{< tab title="Linux package (Omnibus)" >}}
-
Edit
/etc/gitlab/gitlab.rb
and change thegitlab_rails['gitlab_issue_closing_pattern']
value:gitlab_rails['gitlab_issue_closing_pattern'] = /<regular_expression>/.source
-
Save the file and reconfigure GitLab:
sudo gitlab-ctl reconfigure
{{< /tab >}}
{{< tab title="Helm chart (Kubernetes)" >}}
-
Export the Helm values:
helm get values gitlab > gitlab_values.yaml
-
Edit
gitlab_values.yaml
and change theissueClosingPattern
value:global: appConfig: issueClosingPattern: "<regular_expression>"
-
Save the file and apply the new values:
helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
{{< /tab >}}
{{< tab title="Docker" >}}
-
Edit
docker-compose.yml
and change thegitlab_rails['gitlab_issue_closing_pattern']
value:version: "3.6" services: gitlab: environment: GITLAB_OMNIBUS_CONFIG: | gitlab_rails['gitlab_issue_closing_pattern'] = /<regular_expression>/.source
-
Save the file and restart GitLab:
docker compose up -d
{{< /tab >}}
{{< tab title="Self-compiled (source)" >}}
-
Edit
/home/git/gitlab/config/gitlab.yml
and change theissue_closing_pattern
value:production: &base gitlab: issue_closing_pattern: "<regular_expression>"
-
Save the file and restart GitLab:
# For systems running systemd sudo systemctl restart gitlab.target # For systems running SysV init sudo service gitlab restart
{{< /tab >}}
{{< /tabs >}}
To test the issue closing pattern, use Rubular.
Rubular does not understand %{issue_ref}
. When you test your patterns,
replace this string with #\d+
, which matches only local issue references like #123
.