GitHub Actionsで手動と自動のどちらでも実行できるデプロイワークフローを作る

# デプロイをリポジトリへのAPI呼び出しとして実行
$ curl -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <token> \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/<owner>/<repo>/dispatches \
  --data '{ "event_type": "deploy", "client_payload": { "branch": "main", "environment": "production" }}'

name: Deploy

on:
  # API呼び出しで実行
  repository_dispatch:
    types: [deploy]

  # 手動で実行
  workflow_dispatch:
    inputs:
      environment:
        default: staging
        options:
          - staging
          - production
        required: true
        type: choice

jobs:
  setup:
    runs-on: # some runner

    # トリガーするイベントに応じてinputをoutputに変換
    steps:
      - id: setup-from-inputs
        if: github.event_name != 'repository_dispatch'
        run: |
          echo environment=${{ inputs.environment }} >> $GITHUB_OUTPUT
          echo branch=${{ github.ref_name) }} >> $GITHUB_OUTPUT
      - id: setup-from-payload
        if: github.event_name == 'repository_dispatch'
        run: |
          echo environment=${{ github.event.client_payload.environment }} >> $GITHUB_OUTPUT
          echo branch=${{ github.event.client_payload.branch) }} >> $GITHUB_OUTPUT

    # ジョブのoutputとしてenvironmentとbranchを設定
    outputs:
      environment: ${{ steps.setup-from-inputs.outputs.environment || steps.setup-from-payload.outputs.environment }}
      branch: ${{ steps.setup-from-inputs.outputs.branch || steps.setup-from-payload.outputs.branch }}

  # setup.outputs.environmentがproduction以外のときにstagingへのデプロイを実行
  staging:
    needs: setup
    if: needs.setup.outputs.environment != 'production'
    runs-on: # some runner

    # deployment environmentに関する設定
    environment:
      name: staging
      url: https://staging.example.com
    concurrency: staging

    steps:
      - uses: actions/checkout@v3
      - name: deploy
        run: # ...

  # setup.outputs.environmentがproductionのときにproductionへのデプロイを実行
  production:
    needs: setup
    if: needs.setup.outputs.environment == 'production'
    runs-on: # some runner

    # deployment environmentに関する設定
    environment:
      name: production
      url: https://example.com
    concurrency: production

    steps:
      - uses: actions/checkout@v3
      - name: deploy
        run: # ...

name: Deploy

on:
  repository_dispatch:
    types: [deploy]
  workflow_call: # 追加
    inputs:
      environment:
        default: staging
        type: string
  workflow_dispatch:
    # ...

name: Auto deploy

on:
  push:
    branches:
      - master

jobs:
  staging:
    uses: ./.github/workflows/deploy.yml
    with:
      environment: staging
    secrets: inherit