GitHub Actionsを利用してリリースノートの生成を自動化する

GitHub CLI によるリリースノートの生成#

GitHub CLI のgh release createコマンドで--generate-notesオプションを指定すると、コミットログから自動的に GitHub のリリースノートが生成される。

1
gh release create v3.1.4 --generate-notes

参考：gh release create

GitHub Actions 上でリリースノートを生成する#

GitHub Actions 上で GitHub CLI を利用してリリースノートを生成するには、permissionsセクションでcontentsをwriteに設定する必要がある。

1
permissions:
2
  contents: write

また、過去からのコミットログが必要なため、checkout する際にfetch-depthを0に設定する。

1
steps:
2
  - uses: actions/checkout@v4
3
    with:
4
      fetch-depth: 0

GitHub CLI は、GitHub Actions にプリインストールされているため、最小構成は次のようになる。

1
permissions:
2
  contents: write
3

4
jobs:
5
  create-release:
6
    runs-on: ubuntu-latest
7
    steps:
8
      - uses: actions/checkout@v4
9
        with:
10
          fetch-depth: 0
11
      - name: Create Release
12
        run: |
13
          gh release create v1.0.0 --generate-notes
14
        env:
15
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

後はバージョンを何らかの方法で受け取れば良い。

例：タグを打つとリリースノートが生成されるようにする#

タグのプッシュをトリガーにすると、github.ref_nameでタグ名を受け取ることができる。

1
name: Tag Release
2

3
on:
4
  push:
5
    tags:
6
      - "v*"
7

8
permissions:
9
  contents: write
10

11
jobs:
12
  create-release:
13
    runs-on: ubuntu-latest
14
    steps:
15
      - uses: actions/checkout@v4
16
        with:
17
          fetch-depth: 0
18
      - name: Create Release
19
        run: |
20
          gh release create ${{github.ref_name}} --generate-notes
21
        env:
22
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

例：ファイルのバージョン情報を元にリリースノートを生成する#

タグではなく何らかのファイルによりバージョンが管理されているケースを考える。今回は.versionというファイルでバージョンが管理されている想定で、このファイルに記載されたバージョンが更新されるとタグのプッシュとリリースノートの生成がされるようにする。

1
name: Create Release Tag
2

3
on:
4
  push:
5
    branches:
6
      - main
7
    paths:
8
      - ".version"
9

10
permissions:
11
  contents: write
12

13
jobs:
14
  create-tag:
15
    runs-on: ubuntu-latest
16
    steps:
17
      - uses: actions/checkout@v4
18
        with:
19
          fetch-depth: 0
20

21
      - name: Get version
22
        id: version
23
        run: |
24
          VERSION=$(cat .version)
25
          echo "version=$VERSION" >> $GITHUB_OUTPUT
26
      - name: Create and push tag
27
        run: |
28
          git config --local user.email "[email protected]"
29
          git config --local user.name "GitHub Action"
30
          git tag -a "v${{ steps.version.outputs.version }}" -m "Release v${{ steps.version.outputs.version }}"
31
          git push origin "v${{ steps.version.outputs.version }}"
32
      - name: Create GitHub Release
33
        run: |
34
          gh release create "v${{ steps.version.outputs.version }}" --generate-notes
35
        env:
36
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}