0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

GitHub Action Workflow の paths filterの罠

0
Posted at

paths-filter

GitHub Actionsを使っていると、特定のpath配下のファイルの変更だけを検知して実行したいときがあります。
そんなときにはpaths-filterが用意されています。(参考)
しかしpaths-filterはちょっと罠があったので共有したいと思います。

paths-filterの罠

Update BranchでBaseブランチの変更があるとpaths-filterに引っかかってしまう!

例えばこんな感じでOpenAPIのドキュメントを生成したいとき、以下の記述だけで十分そうに見えます。

on:
  pull_request:
    paths:
      - 'openapi/**/*.yml'

OpenAPI の定義ファイルが変わったら、

openapi-generator
swagger-cli bundle
redocly build-docs

みたいな処理を走らせて、

openapi.json
openapi.bundle.yaml
docs/api.html

などを自動生成・コミットする構成にしていたとします。

そして以下のような流れでBaseブランチの変更を取り込んだとします。

  1. 自分の出したPRでは OpenAPI を一切変更していない
  2. base ブランチ側でopenapi/user.yamlが更新された
  3. Update branch を押す

するとbase の OpenAPIの変更がPRに取り込まれるとpaths: openapi/**/*.yml に引っかかってOpenAPI の自動生成が走ってしまいます。

生成された openapi.json や docs/ が更新されてPR に 自分が触っていない API 定義の差分が乗ってしまい、場合によってはコンフリクトを起こしてしまいます。

自分が触っていないファイルでよくわからない差分が発生してコンフリクトを解決しないといけないの、相当イライラしますよね?

じゃあどうするか?

PRの変更ファイルを自前で見ればOKです。
GitHub CLI で

gh pr view <PR番号> --json files

を使うと、PRの変更差分だけとることができます。

外部アクションも不要で、シェル数行で済むので自前で書くのが良いと思います。

最終的にはこんな感じのWorkflowになりました。

name: OpenAPI CI

on:
  pull_request:

jobs:
  check-openapi-changes:
    runs-on: ubuntu-latest
    outputs:
      openapi_changed: ${{ steps.check.outputs.changed }}
    steps:
      - name: Check OpenAPI changes in PR
        id: check
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          FILES=$(gh pr view ${{ github.event.pull_request.number }} \
            --json files --jq '.files.[].path')

          echo "Changed files in PR:"
          echo "$FILES"

          if echo "$FILES" | grep -qE '^openapi/.*\.(ya?ml)$'; then
            echo "changed=true" >> $GITHUB_OUTPUT
          else
            echo "changed=false" >> $GITHUB_OUTPUT
          fi

  generate-openapi:
    needs: check-openapi-changes
    if: needs.check-openapi-changes.outputs.openapi_changed == 'true'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout PR branch
        uses: actions/checkout@v6
        with:
          ref: ${{ github.head_ref }}

      - name: Generate OpenAPI bundle
        run: |
          # 例: swagger-cli
          npm install -g swagger-cli
          swagger-cli bundle openapi/index.yaml \
            --outfile openapi.bundle.yaml \
            --type yaml

      - name: Commit & push generated OpenAPI
        run: |
          if ! git diff --exit-code --quiet; then
            git config user.name github-actions
            git config user.email github-actions@github.com
            git add openapi.bundle.yaml
            git commit -m "chore(openapi): update bundled spec"
            git push
          fi
0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?