SwiftコードのCI/CDをGitHub Actionsで実行する

背景

最近、またちょっとSwiftのコードを触り始めたのですが、そういえばやろうやろうと思いながらSwiftのコードのCI/CDをちゃんとやってこなかったなあというのが気になってきました。

CI

自分の中では、CI/CDには以下の機能を持たせたいと思っています

1. コードのフォーマットと整形
2. テストの実行
3. コミットメッセージのチェック
4. ビルドが通るかどうか

1に関してはTypeScriptの場合にはbiomeで対応していますが、Swiftの場合にはSwiftLintとSwiftFormatが該当します。

SwiftFormatは全く違う二種類のツールがあるので、混同しないようにしないといけません。

テストの実行はXCTestというものがあるのでそれを実行します。UnitTestくらいなら簡単に書けますが、UIのテストとなるとめんどくさそうです。

ライブラリの場合には基本的にUnitTestさえ通ればまあなんとかなるだろうと思っているので、今回はこちらだけ実装しました。

コミットメッセージはGitDocを使ったときにcommitlintのフォーマットに沿うようにコメントを書かせているのですが、たまにLLMが反応せずに日付だけのコミットメッセージが生成されてしまうのでその対策です。

commitlintはNode.jsで動くツールなので、そのためだけにCIの中で一瞬だけインストールするようにしています。ただ、ベースとなるNode.jsはGitHub ActionsのRunnerにデフォルトで入っているのでそこは問題ありません。

ビルドが通るかどうかは、コードの不具合等がないかをチェックします。Bunの場合にはトランスパイルで型チェックなどが行われないので、Bunとは別にtscなどでチェックする必要があるでしょう。Next.jsの場合にはそこも多分やってくれているので単にnext buildが通れば大丈夫です。

ビルドは規模が大きくなると時間がかかる場合もあるので「PRがある場合にしかチェックしない」とかでもいいと思います。

CD

これに加えて、

1. 自動バージョニング
2. デプロイ
3. PRAgentを利用したLLMによるコードレビュー
4. 自動タグ付け

ができれば更に良いなと思っており、いくつかのレポジトリでは実験的に実践しています。

自動バージョニングは割と簡単で、feature/**をdevelopにマージしたときにマイナーバージョンを上げる（0.0.1→0.1.0）、fix/**をdevelopにマージしたときにパッチバージョンを上げる（0.0.1→0.0.2）という単純なもので、　developをmasterにマージしたときにメジャーバージョンを更新するような感じです。

これはGitHub Actions側が勝手にコミットを追加するような感じですので、実際にバージョンを上げるかどうかはマージするまでわからないのでマージ後にマージ先のブランチでバージョンを上げるという処理をしています。

ただ、マージ後にマージ元にコミットを追加してしまう方式でもいいかもしれません。

デプロイに関しては現状、Container Registry、Vercel、 Netlify、 Package Registry、 Docker Hub、 Cloudflare Pages、 Cloudflare Workersに関しては一通り試しています。

VercelやNetlify, Cloudflare系はGit連携して自動でデプロイなどもできますが、自分の好きなタイミングでデプロイできることなどからGitHub Actionsを利用しています。

LLMでの自動コードレビューは中身をガッツリ読んでいるわけではないのですが、たまにミスがあったときなどに教えてくれるので重宝しています。コストもmini系を使えばほぼタダ同然なので便利です。

自動タグ付けはまだほぼ実践できていません。だって他に使う人がいないですし…

GitHub Actions

では、本命のSwiftコード用のGitHub Actionsですが、以下のようにしてみました。

1
name: Continuous Integration
2
on:
3
  push:
4
jobs:
5
  commitlint:
6
    name: CommitLint
7
    if: github.event.action != 'closed' || github.event.pull_request.merged != true
8
    runs-on: ubuntu-latest
9
    steps:
10
      - name: Checkout
11
        uses: actions/checkout@v4
12
      - name: Bun
13
        uses: oven-sh/setup-bun@v1
14
        with:
15
          bun-version: latest
16
      - name: Install commitlint
17
        run: |
18
          bun install conventional-changelog-conventionalcommits
19
          bun install commitlint@latest
20
          bun install @commitlint/config-conventional@latest
21
      - name: Validate current commit (last commit) with commitlint
22
        if: github.event_name == 'push'
23
        run: bunx commitlint --last --verbose
24
      - name: Validate PR commits with commitlint
25
        if: github.event_name == 'pull_request'
26
        run: bunx commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose
27
  check:
28
    name: Code Check
29
    runs-on: macos-latest
30
    if: github.event.action != 'closed' || github.event.pull_request.merged != true
31
    steps:
32
      - name: Checkout
33
        uses: actions/checkout@v4
34
      - name: Install dependencies
35
        run: |
36
          brew install swiftlint swiftformat
37
      - name: Run SwiftLint
38
        run: |
39
          swiftlint
40
      - name: Run SwiftFormat in lint mode
41
        run: |
42
          swiftformat . --lint
43
  test:
44
    name: Test
45
    runs-on: macos-15
46
    if: github.event.action != 'closed' || github.event.pull_request.merged != true
47
    steps:
48
      - name: Checkout
49
        uses: actions/checkout@v4
50
      - uses: maxim-lobanov/setup-xcode@v1
51
        with:
52
          xcode-version: 16.4
53
      - name: Build the Swift package
54
        run: |
55
          swift build --build-tests
56
      - name: Run tests
57
        run: |
58
          swift test

ポイントとなるところはmacos-15を指定している点で、まだmacos-latest!=macos-15らしいです。なので、macos-latestを指定するとXcode 16.4が使えなくなってしまいます。

コミットのチェックに関してはUbuntuでも実行できるのであえてmacos-latestは利用していません。

swiftlintとswiftformatは最初から入っていたりもするのですが、一応インストールするようにしています。この内容で、ちゃんと動いていることが確認できたので多分大丈夫だと思います。

まとめ

LLMの力を借りてGitHub Actionsを書いてみたのですが、非常に簡単にかけて驚いています。

実際にアプリをビルドしてリリースするところもfastlaneなどを利用してかければなと思っています。これに関してはおそらく一ヶ月以内くらいに記事にするでしょう。

早くAppleの審査が終わらないかなと思っています。

記事は以上。