GitHub Actionsでタグ管理、バージョン管理を行う

背景

packge.jsonのバージョン管理とか忘れるし、適当にタグつけたらそのコミットでは動作しなかったりで本当に困る…

こういうのを自動で管理してくれる仕組みはないのか…

それ、GitHub Actionsでできますよ！！！

要望

プッシュされるとデフォルトブランチ以外の全てのブランチでテスト・ビルドが実行される
- ビルドまでは不要な気がするが、異なる変更を複数取り込んだ結果動かなくなることもあるので念の為
- 開発用ブランチはデフォルトをリベースしたもの(この表現で正しいのかわからないが)なので開発用ブランチで動くことが確認できれば十分
デフォルトブランチはプロテクションを利用して直接プッシュできないようにする
- これ必須
- 開発用ブランチはギリ、オレオレ認証を許すが本番へのPRではこの特権を使えないようにする
デフォルトブランチにマージされたらタグを付ける
- ついでにDockerイメージを作成してGHCRにプッシュする
- そこにもタグを付ける
デフォルトブランチへのプルリクエストが作成されたらバージョンを確認する
- バージョンが上がらないようなプルリクエストは通さない

これを満たすとどうなるかというと、

新機能を開発したいと思ったら開発用ブランチから切って作成する
コミットしたらプッシュする
プッシュすると自動でCI(テストとビルド)が行われる
動かない機能が追加されたものはそもそも開発用ブランチにマージできない
CIが通れば開発用ブランチにマージできる
追加したい機能がいくつかたまったらデフォルトブランチにプルリクエストを出す
このときCI(バージョンチェック、テスト、ビルド)が行われる
バージョンが上がっていないとテストが通らないのがミソ
差分をチェックしてCI(ラベル付け)で適切なラベルが割り当てられる
レビューが終わればマージする
マージされるとCD(タグ作成、ビルド、イメージ作成)でコミットにタグがつく
ビルドしたDockerのイメージがGHCRにプッシュされ、自動でリリースされる

つまり、管理しなければいけないのはpackage.jsonのバージョンの値だけということになり、その他の面倒くさい作業は全てGitHub ActionsがCI/CDの一環として行ってくれるわけです。

一番のポイントはバージョンが更新されていなければCIが通らずにそもそもマージができないので、正しくマージできればバージョンがちゃんと更新されていることが保証されることです！しかも同時にタグまでつけてくれるのでこれでバージョン管理の煩わしさから解放されるというわけですね。

ネットの広大な知識を検索しているとラベルを付けたときにバージョンを更新するといったような記事も見かけたのですが、今回はその機能は見送りました。

特に問題はないと思うのですが、その機能をつけるとバージョンの管理がめんどくさくなる気がしたためです

コミットをhuskyで管理しているなら破壊的変更のコミットが含まれていると自動でメジャーアップデート扱いにする、みたいな操作ができればより便利かと思いました。

GitHub Actionsの中身

バージョンチェック

プルリクエストが更新されとたときにプルリクエストのマージ先とマージ元のバージョンを比較して更新されているかを確認します。

更新されていない場合はエラーを返します。

package.jsonしかチェックできませんが、パスを指定することもできます。

1
name: Check Version Update with Pull Request
2

3
inputs:
4
  path:
5
    description: 'Path to package.json'
6
    required: false
7
    default: '.'
8
outputs:
9
  semver:
10
    description: 'Semantic Versioning'
11
    value: ${{ steps.check-version-update.outputs.semver }}
12

13
runs:
14
  using: 'composite'
15
  steps:
16
    - name: Checkout
17
      uses: actions/checkout@v4
18
      with:
19
        ref: ${{ github.base_ref }}
20

21
    - name: Current Version
22
      id: current_version
23
      shell: bash
24
      run: |
25
        echo "version=$(cat ${{ inputs.path }}/package.json | jq -r '.version')" >> $GITHUB_OUTPUT
26

27
    - name: Checkout
28
      uses: actions/checkout@v4
29
      with:
30
        ref: ${{ github.ref }}
31

32
    - name: Release Version
33
      id: release_version
34
      shell: bash
35
      run: |
36
        echo "version=$(cat ${{ inputs.path }}/package.json | jq -r '.version')" >> $GITHUB_OUTPUT
37

38
    - name: Check version update
39
      id: check-version-update
40
      shell: bash
41
      run: |
42
        release_version=${{ steps.release_version.outputs.version }}
43
        release_ver_array=(${release_version//./ })
44
        current_version=${{ steps.current_version.outputs.version }}
45
        current_ver_array=(${current_version//./ })
46
        if [ ${release_ver_array[0]} -gt ${current_ver_array[0]} ]; then echo "semver=Semver-Major" >> "$GITHUB_OUTPUT"; exit 0; fi
47
        if [ ${release_ver_array[0]} -eq ${current_ver_array[0]} ] && [ ${release_ver_array[1]} -gt ${current_ver_array[1]} ]; then echo "semver=Semver-Minor" >> "$GITHUB_OUTPUT"; exit 0; fi
48
        if [ ${release_ver_array[0]} -eq ${current_ver_array[0]} ] && [ ${release_ver_array[1]} -eq ${current_ver_array[1]} ] && [ ${release_ver_array[2]} -gt ${current_ver_array[2]} ]; then echo "semver=Semver-Patch" >> "$GITHUB_OUTPUT"; exit 0; fi
49
        echo "Please update version in package.json"
50
        exit 1

ラベル付け

上のバージョンチェックが通った際の返り値をプルリクエストにラベルとしてつけます。

1
name: Set Label to Pull Request
2
inputs:
3
  semver:
4
    required: true
5
runs:
6
  using: 'composite'
7
  steps:
8
    - uses: actions/github-script@v7
9
      with:
10
        script: |
11
          const { SEMVER } = process.env
12
          github.rest.issues.setLabels({
13
            owner: context.repo.owner,
14
            repo: context.repo.repo,
15
            issue_number: context.payload.pull_request.number,
16
            labels: [SEMVER]
17
          });
18
      env:
19
        SEMVER: ${{ inputs.semver }}

バージョン管理

上の二つを組み合わせたものです。

バージョンチェックはデフォルトブランチにマージするプルリクエストに対してのみ実行するようにします。

1
name: Semantic Versioning
2

3
on:
4
  pull_request:
5
    branches:
6
      - '**'
7
      - 'develop'
8

9
jobs:
10
  version:
11
    if: github.base_ref == 'master'
12
    runs-on: self-hosted
13
    steps:
14
      - name: Checkout
15
        uses: actions/checkout@v4
16

17
      - name: Check version update
18
        id: check-version-update
19
        uses: ./.github/workflows/actions/check-version-update
20

21
      - name: Set Label to Pull Request
22
        uses: ./.github/workflows/actions/set-label
23
        with:
24
          semver: ${{ steps.check-version-update.outputs.semver }}

タグ付け

デフォルトブランチへのプルリクエストがマージされたときに実行されます。

1
name: Continuous Deployment
2

3
on:
4
  pull_request:
5
    branches:
6
      - 'main'
7
      - 'master'
8
      - 'develop'
9
    types: [closed]
10

11
jobs:
12
  set_tag:
13
    if: github.event.pull_request.merged == true && github.base_ref == 'master'
14
    runs-on: self-hosted
15
    steps:
16
      - name: Checkout code
17
        uses: actions/checkout@v4
18

19
      - name: Get Version
20
        id: current_version
21
        run: |
22
          echo "version=$(cat package.json | jq -r '.version')" >> $GITHUB_OUTPUT
23

24
      - name: Set Tags
25
        run: |
26
          git fetch origin ${{ github.event.pull_request.head.ref }}
27
          git checkout ${{ github.event.pull_request.head.ref }}
28
          git tag `echo '${{ github.event.pull_request.head.ref }}'`
29
          git push origin `echo '${{ github.event.pull_request.head.ref }}'`

デプロイ

プルリクエストのターゲットがデフォルトブランチか開発用ブランチかで最後のタグ付けを少し変えています。

Docker Hubにプッシュする方法もあるのですが、GHCRを利用すれば特別なログイン操作などが不要なので便利です。

1
name: Continuous Deployment
2

3
on:
4
  pull_request:
5
    branches:
6
      - 'main'
7
      - 'master'
8
      - 'develop'
9
    types: [closed]
10

11
jobs:
12
  deploy:
13
    if: github.event.pull_request.merged == true
14
    runs-on: self-hosted
15
    steps:
16
      - name: Checkout code
17
        uses: actions/checkout@v4
18

19
      - uses: benjlevesque/short-sha@v3.0
20
        id: hash
21
        with:
22
          length: 7
23

24
      - name: Get Version
25
        id: current_version
26
        run: |
27
          echo "version=$(cat package.json | jq -r '.version')" >> $GITHUB_OUTPUT
28

29
      - name: Set up QEMU
30
        uses: docker/setup-qemu-action@v3
31

32
      - name: Set up Docker Buildx
33
        uses: docker/setup-buildx-action@v3
34

35
      - name: Login to GitHub Container Registry
36
        uses: docker/login-action@v3
37
        with:
38
          registry: ghcr.io
39
          username: ${{ github.repository_owner }}
40
          password: ${{ secrets.GITHUB_TOKEN }}
41

42
      - name: Build and push
43
        uses: docker/build-push-action@v5
44
        if: github.base_ref == 'develop'
45
        with:
46
          context: .
47
          file: Dockerfile
48
          platforms: linux/amd64,linux/arm64
49
          push: ${{ github.event_name == 'pull_request' }}
50
          tags: |
51
authors: ['tkgstrator']
52
            ghcr.io/${{ github.repository_owner }}/av5ja_stats_api:${{ steps.hash.outputs.sha }}
53
            ghcr.io/${{ github.repository_owner }}/av5ja_stats_api:develop
54

55
      - name: Build and push
56
        uses: docker/build-push-action@v5
57
        if: github.base_ref == 'master'
58
        with:
59
          context: .
60
          file: Dockerfile
61
          platforms: linux/amd64,linux/arm64
62
          push: ${{ github.event_name == 'pull_request' }}
63
          tags: |
64
authors: ['tkgstrator']
65
            ghcr.io/${{ github.repository_owner }}/av5ja_stats_api:${{ steps.current_version.outputs.version }}
66
            ghcr.io/${{ github.repository_owner }}/av5ja_stats_api:latest