【GitHub Actions】Pull Requestのラベル付与状況で制御を分岐する [Techblog#4]

Folklore (このホームページ) では、GitHub Actions でビルドとデプロイを行なっています

その際 PR (Pull Request) のラベルの付与状態により、デプロイを行うかどうか判別しています

デプロイ自体は、以下のタイミングで行われるのですが...

いずれもデプロイして確認したり更新する必要がない場合もあり、少しでも Actions の時間節約に利用しています

平常時はデプロイしますが、このようなラベルが付与されている場合は、デプロイをキャンセルします

ここでは以上のラベル名を使っていますが、適宜読み替えてください

トリガーが PR に依存しているか否かで、制御の書き方が異なります

PR 起票時・再 Push 時

トリガーが PR に依存している場合は、以下のようにして簡潔に分岐を作ることができます

if ブロックで条件を書けるので、GitHub Actions の利用時間に加算されません

name: Staging Deploy by Push trigger
on:  pull_request:    types: [opened, synchronize]
jobs:  deploy:    runs-on: ubuntu-latest    if: |      ((github.event.action == 'opened') &&        !contains(github.event.pull_request.labels.*.name, 'no-staging-deploy')) ||      ((github.event.action == 'synchronize') &&        !contains(github.event.pull_request.labels.*.name, 'no-staging-deploy'))    steps:      - name: Deploy        run: |          echo "Deploy"

おまけですが、途中でラベルの付与が外されてもデプロイしたい場合は、以下のように用意しておくこともできます

name: Staging Deploy by Label change trigger
on:  pull_request:    types: [unlabeled]
jobs:  deploy:    runs-on: ubuntu-latest    if: |      (github.event.action == 'unlabeled') &&      (github.event.label.name == 'no-staging-deploy')    steps:      - name: Deploy        run: |          echo "Deploy"

デフォルトブランチマージ時

これは PR のトリガーに依存しないため PR のラベルを簡単に取得することができず、若干複雑です

判定にマシンを利用するため GitHub Actions の利用時間に加算されます

コミットメッセージの PR 番号を利用するため PR がマージされる時に自動で生成されるメッセージである必要があります

Merge pull request #1 from user/branch

PR からデフォルトブランチにマージするルールの運用のもとでは問題ないかと思います

name: Production Deploy
on:  push:    branches:      - main
jobs:  check_labels:    runs-on: ubuntu-latest    permissions:      pull-requests: read
    steps:      - name: Get the merged PR Number        id: pr        run: |          if [[ '${{ github.event.head_commit.message }}' =~ Merge\ pull\ request\ \#([0-9]+) ]]; then            echo "number=${BASH_REMATCH[1]}" >> $GITHUB_OUTPUT          else            echo 'PR Number not found in the commit message.'            exit 1          fi        shell: bash
      - name: Check the PR labels        id: check-labels        run: |          LABELS=$(curl --silent --show-error --header "Authorization: Bearer ${{ github.token }}" \            https://api.github.com/repos/${{ github.repository }}/issues/${{ steps.pr.outputs.number }}/labels | \            jq -r '.[].name')            if echo "$LABELS" | grep -q "no-production-deploy"; then              echo "skip=true" >> $GITHUB_OUTPUT            else              echo "skip=false" >> $GITHUB_OUTPUT            fi        shell: bash
      - name: Deploy        if: steps.check-labels.outputs.skip != 'true'        run: |          echo "Deploy"

これで PR のラベルを元に Actions の挙動を変更することができます 🎉

  steps:    - name: Get the merged PR Number      id: pr      run: |        PR_NUMBER=$(curl --silent --show-error --header "Authorization: Bearer ${{ github.token }}" \          https://api.github.com/repos/${{ github.repository }}/pulls?state=closed | \          jq '.[] | select(.merged_at!=null) | .number' | head -1)        echo "number=$PR_NUMBER" >> $GITHUB_OUTPUT      shell: bash