GitHub Actionsで自動でバージョニングしたい話

概要

NodeJSで動くパッケージなどを作っている際に気になるのがタグ付けとバージョン管理です。

これらは本来のコミットとズレてしまっては意味がないのですが、自分はよくタグ付けを間違えてしまったり忘れてしまったりします。

そこで、GitHub Actionsを使ってこれらを一元管理できないかを考えました。

求める仕様

レポジトリには何らかのバージョンを管理するファイルがある
- NodeJS向けのやつだとpackage.jsonのversionの値を参照する
masterまたはmainにPull Request経由でマージされた際にGitHub Actionsが実行される
- バージョンが上がっていることを確認する(最悪、バージョンが被っていないとかでも良い)
- バージョンが上がっていればタグを作成する
DockerfileがあればDocker Imageを作成する
- そのイメージに自動でバージョンでタグを付ける
そのイメージがDocker HubにPushされる

さて、これらについていろいろ調べていきましょう。

GitHub Actions

バージョン管理

package.jsonからバージョンを取得するのは偉い人がMarketplaceでGet current package versionを公開してくれているのでそれを利用します。

1
- name: Get Package Version
2
  id: version
3
  uses: martinbeentjes/npm-get-version-action@v1.3.1
4
  with:
5
    path: .
6

7
- name: Check Version
8
  run: echo "Version is ${{ steps.version.outputs.current-version }}"

このpathはドキュメントルートからのpackage.jsonへのパスなので特に何もなければ.となるはずです。

取得した値へのアクセスは${{ steps.version.outputs.current-version }}で行えます。

タグとラベルの管理

Dockerでのタグとラベルの管理については公式ドキュメントに記載があったのでこれを読み解きます。

で、ここではDocker HubではなくGitHub Container Registryを利用するようです。

1
jobs:
2
  docker:
3
    runs-on: ubuntu-latest
4
    steps:
5
      - name: Checkout
6
        uses: actions/checkout@v4
7

8
      - name: Metadata
9
        id: meta
10
        uses: docker/metadata-action@v5
11
        with:
12
          # 環境変数 github.repositoryを利用する
13
          images: |
14
            ghcr.io/${{ github.repository }}
15
          tags: |
16
authors: ['tkgstrator']
17
            type=schedule
18
            type=ref,event=branch
19
            type=ref,event=pr
20
            type=semver,pattern={{version}}
21
            type=semver,pattern={{major}}.{{minor}}
22
            type=semver,pattern={{major}}
23
            type=sha
24

25
        # マルチプラットフォームビルドに必要
26
      - name: Set up QEMU
27
        uses: docker/setup-qemu-action@v3
28

29
      - name: Set up Docker Buildx
30
        uses: docker/setup-buildx-action@v3
31

32
      - name: Login to GitHub Container Registry
33
        if: github.event_name != 'pull_request'
34
        uses: docker/login-action@v3
35
        with:
36
          registry: ghcr.io
37
          username: ${{ github.repository_owner }}
38
          # 別途トークンを用意するみたいな記事もあるけど不要
39
          password: ${{ secrets.GITHUB_TOKEN }}
40

41
      - name: Build and push
42
        uses: docker/build-push-action@v5
43
        with:
44
          context: .
45
          file: Dockerfile
46
          push: ${{ github.event_name != 'pull_request' }}
47
          tags: ${{ steps.meta.outputs.tags }}
48
authors: ['tkgstrator']
49
          labels: ${{ steps.meta.outputs.labels }}

ここでのポイントはimagesに対してghcr.io/${{ github.repository }}を割り当てるということ。こうすればどんなレポジトリに対しても共通のYAMLが書けます。

GITHUB_TOKENは組織のレポジトリであってもそこに所属しているユーザーのトークンが利用できるのでDeveloper Settingsからトークンを発行しましょう。