これはエムスリー Advent Calendar 2022の32日目の記事です。前日は@po3rinによる、ただのソフトウェアエンジニアが検索エンジニアになるまででした。

あけましておめでとうございます。エムスリーエンジニアリンググループでScalaとマミさんが好きな安江です。アドカレを購読しているみなさま、またお目に掛かりましたね。素敵な出会いはたくさんあって欲しいですが、プログラマなら似たコードとの出会いは少なくしたいものです。今年度のAI・機械学習のベストMR第1位に輝いたのもGitLab CIテンプレート用リポジトリの作成という、GitLab CIのテンプレートに関するものでした。本記事では、私が布教したGitLab CIのテンプレートの実例を3つ紹介したいと思います。

1. レビュー依頼ジョブ

こちらの記事 *1でも紹介しましたが、レビューの依頼は単にマージリクエストを作成して終わり、というのは滅多にありません。対応する課題を作ったり、slackに依頼したりと、チームによってさまざまです。複雑な手順は、普段から開発しているメンバーにとっても煩わしいですし、チーム外からコントリビュートしたいメンバーにとってはとてもハードルが高いものになります。こちらのテンプレはGitLab CIジョブにレビュー依頼を作成します。これによって、レビュー依頼はこちらのジョブを手動実行する、というインタフェースに統一され、気軽にレビュー依頼できるようになりました。やったね！

2. 古いブランチの通知

皆さんが管理するリポジトリに古いブランチはありませんか？必要以上に残ってしまったトピックブランチの対処、問題になっていたりしませんか？こちらのジョブは3か月動きがなかったブランチ*2の最新コミッターに対してslackに通知します。GitLabの場合、ブランチが削除されると、それに紐づくマージリクエストや環境も破棄されるため、通知のトリガーはブランチだけで良いのです。

不要なブランチはリモートリポジトリサイズの肥大化にも繋がるので、削除しちゃいましょう*3。年始から綺麗なリポジトリとともに開発できると、気分も晴れやかになること請け合いです。

3. renovate, scala stewardのテンプレート

サービスが依存しているライブラリの更新管理、大変ですよね。もはや一般的になったrenovateやscala stewardの導入を手軽にするテンプレートを用意しました。特にrenovateのテンプレートは、私が所属するチーム以外でも採用されました。需要の高さが伺えますね。是非、読者の皆さんにも使ってもらいたいので、ここに弊社で使っている実例を置いておきますね。

（scala stewardの実例は過去の記事をご参照ください）

renovate

テンプレートリポジトリに下記のymlを置きます。環境変数などはこちらを参考に設定してください。

.renovate:
  image:
    name: renovate/renovate:latest
    entrypoint: [ "" ]
  script:
    - renovate
      --platform gitlab
      --endpoint "GitLabのAPIのベースURL"
      --allowed-post-upgrade-commands='[".*"]'
      "${CI_PROJECT_PATH}"
  variables:
    RENOVATE_TOKEN: ${RENOVATE_TOKEN}
    GITHUB_COM_TOKEN: ${GITHUB_COM_TOKEN}

導入先のリポジトリに renovate.json を置きます。Java+JavaScriptの例を下記に示します。

{
  "extends": ["config:base"],
  "includePaths": ["pom.xml", "src/main/resources/package.json"],
  "timezone": "Asia/Tokyo",
  "enabledManagers": ["maven", "npm"],
  "addLabels": ["レビュー待ち"],
  "branchPrefix": "renovate/",
  "separateMinorPatch": true,
  "packageRules": [
    {
      "groupName": "backend-dependencies",
      "matchManagers": "maven"
    },
    {
      "groupName": "frontend-dependencies",
      "matchManagers": "npm",
      "matchDepTypes": ["dependencies", "devDependencies"]
    }
  ],
  "baseBranches": ["develop"],
  "prFooter": "This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate)."
}

導入先のリポジトリの .gitlab-ci.yml に以下を追加します。

include:
  - project: m3/ci-templates # テンプレートリポジトリ名
    ref: master
    file: renovate/renovate.yml # テンプレートファイルのルートからのパス

renovate_manual:
  extends: .renovate
  needs: [ ]
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule" || $CI_PIPELINE_SOURCE == "merge_request_event"'
      when: never
    - if: $CI_COMMIT_BRANCH == "develop"
      when: manual
      allow_failure: true

renovate_scheduled:
  extends: .renovate
  needs: [ ]
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule" && $CI_COMMIT_BRANCH == "develop" && $renovate'

renovate_manualはtestステージに出現する手動ジョブで、デバッグ用です。renovate_scheduledをスケジュール登録することで、developブランチのライブラリの更新を監視できるようになります。他のスケジュールジョブと干渉を防ぐためにrenovate変数が定義されている場合のみ、実行されるようになっています。