Github Actionで特定のブランチの場合のみ実行する処理を書く

先日、Github Actionで自動コミット設定をするの対応を行ったが、Actionのトリガーを

on: [push]

にしていると、ブランチでもAPI仕様書の更新が実行されてしまいコンフリクトが発生する問題が起きた。

そこで、↓のようにif文を追加し、masterの場合のみ自動コミットを実行するように対応した。

ついでにgit-auto-commit-actionのオプションも設定しておいた。

      - name: Cleanup
        working-directory: ./doc
        run: |
          rm -rf *
      - name: Generate API doc
        run: |
          yarn run generate-api-docs
      - name: Update API docs
        if: contains(github.ref, 'master')
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          branch: master
          commit_message: Update API docs
          file_pattern: api_docs/**/*

参考

• Git Auto Commit · Actions · GitHub Marketplace · GitHub
• run step on (if branch/tag is) - GitHub Actions - GitHub Support Community