GitHub Actionsで次のリリースにどんな変更が含まれるかを可視化する

この記事ははてなエンジニア Advent Calendar 2021 の16日目の記事です。昨日は id:masayosu のはてなにおけるCloudNative推進会の活動についてでした。サブ会という仕組みで専門領域における情報共有や深い議論ができるようになっていて、僕もスマート会*1に所属しています

はてなではリリースブランチへのマージPRの管理にgit-pr-releaseをよく使っています。 git-pr-releaseは現在のリリースブランチのheadとの差分にあるPull Requestを一覧して、リリース前にチェックできます。このgit-pr-releaseはとても便利で、git-flowのようなブランチ戦略に非常にマッチしています。

一方、リリースブランチのないGitHub Flowのようなブランチ戦略を取った場合、リリースブランチが作られないため、マージ先のブランチがなく、PRも作れません。リリースブランチがなくてもgit-pr-releaseのようなリリース管理をしたい！と思ったので、同じようなリリース差分をGitHub Actionsを使ってIssueに可視化できるようにしてみました。

Issueで管理するのでgit-issue-releaseです。

github.com

PRをマージすると、GitHubのAutomatically generated release notesのAPIを使い、直近リリースからの差分をIssueに記録します。GitHubのReleaseがPublishされると、Issueはクローズされます。全体のフローを動画に短くまとめました。

youtu.be

使い方

GitHub Actionsで動作します。以下のYAMLを .github/workflows以下に配置することで使えます。

name: git-issue-release

on:
  pull_request: # PRがマージされた時にIssueを更新するために使います。
    types: [closed]
  release: # ReleaseがPublishされた時にIssueをクローズするために使います。
    types: [published]

jobs:
  action:
    runs-on: ubuntu-latest
    steps:
      - name: git-issue-release
        uses: kouki-dan/git-issue-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          release-tag-pattern: ^v  # 最新のリリースを探すために使います。
          release-label: "release"  # リリースIssueを管理するために使います。ラベルは自動で作られないので事前に作成してください。