イシュークロージングパターン

note
このページでは、管理者がissueクローズ・パターンを設定する方法について説明します。この機能に関するユーザー・ドキュメントは、自動的にイシューをクローズするを参照してください。

コミットやマージリクエストが1つ以上のイシューを解決する場合、コミットやマージリクエストがプロジェクトのデフォルトブランチに到着したときに、これらのイシューを自動的にクローズすることができます。

イシューのクローズパターンの変更

デフォルトのイシュー終結パターンは、幅広い単語をカバーしています。ニーズに合わせてパターンを変更できます。

デフォルトのイシュー終結パターンを変更するには

Linux package (Omnibus)
  1. /etc/gitlab/gitlab.rb を編集し、gitlab_rails['gitlab_issue_closing_pattern'] の値を変更します:

    gitlab_rails['gitlab_issue_closing_pattern'] = /<regular_expression>/.source
    
  2. ファイルを保存して GitLab を再設定してください:

    sudo gitlab-ctl reconfigure
    
Helm chart (Kubernetes)
  1. Helm の値をエクスポートします:

    helm get values gitlab > gitlab_values.yaml
    
  2. gitlab_values.yaml を編集し、issueClosingPattern の値を変更します:

    global:
      appConfig:
        issueClosingPattern: "<regular_expression>"
    
  3. ファイルを保存して、新しい値を適用します:

    helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
    
Docker
  1. docker-compose.yml を編集し、gitlab_rails['gitlab_issue_closing_pattern'] の値を変更します:

    version: "3.6"
    services:
      gitlab:
        environment:
          GITLAB_OMNIBUS_CONFIG: |
            gitlab_rails['gitlab_issue_closing_pattern'] = /<regular_expression>/.source
    
  2. ファイルを保存して GitLab を再起動します:

    docker compose up -d
    
Self-compiled (source)
  1. /home/git/gitlab/config/gitlab.yml を編集し、issue_closing_pattern の値を変更します:

    production: &base
      gitlab:
        issue_closing_pattern: "<regular_expression>"
    
  2. ファイルを保存して GitLab を再起動します:

    # For systems running systemd
    sudo systemctl restart gitlab.target
       
    # For systems running SysV init
    sudo service gitlab restart
    

イシューを閉じるパターンをテストするには、https://rubular.com を使います。しかし、Rubular は%{issue_ref} を理解できません。パターンをテストする際には、この文字列を#\d+に置き換えてください。この文字列は#123のような内部イシュー参照にのみマッチします。