[GitHub Actions]repository_dispatchとworkflow_dispatchの使い分けや書き方の違いをまとめてみた

name: Workflow as entrypoint (repository_dispatch)
'on':
  push:

略

    steps:
      - uses: actions/checkout@v2

      # Repository DispatchのActionであるpeter-evans/repository-dispatch@v1で渡すclient-payloadでは、ベタ書きと変数を組み合わせて新たな変数を定義することができなかった
      # そこで適当なファイルにclient-payloadで渡したい変数をechoし、juliangruber/read-file-action@v1でその変数を扱えるようにした
      # echoする際、-nオプションをつけて改行が入らないようにしないとpeter-evans/repository-dispatch@v1でclient-payloadをセットするところでエラーを引く
      - name: Set app rpeository workflow url
        run: echo -n "${{ env.APP_REPOSITORY_URL }}/actions/runs/${GITHUB_RUN_ID}" > /tmp/.appwf.txt

      - name: Read appwf.txt
        # https://github.com/marketplace/actions/read-file
        id: read-appwf
        uses: juliangruber/read-file-action@v1
        with:
          path: /tmp/.appwf.txt

      ### Manifest repository dispatch
      # https://github.com/marketplace/actions/repository-dispatch
      - name: Repository Dispatch
        uses: peter-evans/repository-dispatch@v1
        with:
          #token: ${{ secrets.GITHUB_TOKEN }}
          token: ${{ secrets.ACTIONS_PLAYGROUND_REPOSITORY_DISPATCH }} # リポジトリがpublic, privateどちらであってもPersonal Access Tokenが必要
          repository: ${{ env.MANIFEST_REPOSITORY_OWNER }}/${{ env.MANIFEST_REPOSITORY }}
          event-type: ${{ env.REPOSITORY_DISPATCH_EVENT_TYPE }}
          client-payload: '{
            "ref": "work",
            "github_sha": "${{ github.sha }}", 
            "appwf_url": "${{ steps.read-appwf.outputs.content }}"}'

      # Curlを使う場合
      #- name: Repository Dispatch with curl command
      #  run: |
      #    curl -X POST \
      #    -H "Accespt: application/vnd.github.v3+json" \
      #    -H "Authorization: token <PAT_REPOSITORY_DISPATCH>" \
      #    https://api.github.com/repos/gkzz/actions-dispatch-playground/dispatches \
      #    -d '{"event_type": "${{ env.REPOSITORY_DISPATCH_EVENT_TYPE }}", "client_payload": {"github_sha": "${{ github.sha }}", "appwf_url": "${{ steps.read-appwf.outputs.content }}"}}'

name: Subsequent workflow (repository_dispatch)
'on':
  repository_dispatch:
    # typesというパラメータが用意されており、これを使って呼び出しに応じるか制御できる
    types: [release-stg]

jobs:
  main:
    runs-on: 'ubuntu-20.04'

    steps:
      - uses: actions/checkout@v2
        # 呼び出し元が指定しているref(ブランチ)に応じてjobを実行するか制御できる
        if: github.event.client_payload.ref == 'work'
      - name: echo inputs from repository dispatch
        if: github.event.client_payload.ref == 'work'
        run: |
          echo "App's repository sha"
          echo "'${{ github.event.client_payload.github_sha }}'"
          echo "App's workflow url"
          echo "'${{ github.event.client_payload.appwf_url }}'"          

略
    steps:
      - uses: actions/checkout@v2

      - name: Set app rpeository workflow url
        run: echo -n "${{ env.APP_REPOSITORY_URL }}/actions/runs/${GITHUB_RUN_ID}" > /tmp/.appwf.txt

      - name: Read appwf.txt
        # https://github.com/marketplace/actions/read-file
        id: read-appwf
        uses: juliangruber/read-file-action@v1
        with:
          path: /tmp/.appwf.txt

      - name: Workflow Dispatch
        # https://github.com/benc-uk/workflow-dispatch
        uses: benc-uk/workflow-dispatch@v1
        with:
          workflow: Subsequent workflow (workflow_dispatch)
          #token: ${{ secrets.GITHUB_TOKEN }}
          token: ${{ secrets.ACTIONS_PLAYGROUND_WORKFLOW_DISPATCH }} # リポジトリがpublic, privateどちらであってもPersonal Access Tokenが必要
          repo: 'gkzz/actions-dispatch-playground'
          ref: 'work'
          # inputsはpeter-evans/repository-dispatch@v1でいうところのclient-payload、あるいはcurlコマンドの--dataオプションで渡す値
          inputs: '{
            "github_sha": "${{ github.sha }}", 
            "appwf_url": "${{ steps.read-appwf.outputs.content }}"}'

      # curlを使う場合
      # https://docs.github.com/ja/rest/reference/actions#create-a-workflow-dispatch-event
      # https://zenn.dev/masaaania/articles/c930f2f755a577
      #- name: Workflow Dispatch with curl command
      #  run: |
      #    curl -X POST \
      #    -H "Accespt: application/vnd.github.v3+json" \
      #    -H "Authorization: token <PAT_WORKFLOW_DISPATCH>" \
      #    https://api.github.com/repos/gkzz/actions-dispatch-playground/actions/workflows/wf_dispatch_release.yml/dispatches \
      #    -d '{"ref":"main", "inputs":{"github_sha": "${{ github.sha }}", "appwf_url": "${{ steps.read-appwf.outputs.content }}"}}'

name: Subsequent workflow (workflow_dispatch)

on:
  workflow_dispatch:
    # requiredオプションやdefault値を使ってパラメータの値判定や制御ができる
    inputs:
      github_sha:
        description: "App's repository sha"
        required: true
        default: "github_sha_not_found"
      appwf_url:
        description: "App's workflow url"
        required: true
        default: "appwf_url_not_found"


jobs:
  main:
    runs-on: 'ubuntu-20.04'

    steps:
      - uses: actions/checkout@v2
        # repository_dispatch同様、workflow_dispatchでも呼び出し元が指定しているref(ブランチ)に応じてjobを実行するか制御できるが、workflow_dispatchでは、refが必須パラメータであり、これを参照して該当ブランチのWorkflowを実行できる
        if: github.event.client_payload.ref == 'work'
      - name: echo inputs from workflow dispatch
        if: github.event.client_payload.ref == 'work'
        run: |
          echo "App's repository sha"
          echo "'${{ github.event.inputs.github_sha }}'"
          echo "App's workflow url"
          echo "'${{ github.event.inputs.appwf_url }}'"          

   steps:
      - uses: actions/checkout@v2
        if: github.event.client_payload
        with:
          token: ${{ secrets.YOUR_PERSONAL_ACCESS_TOKEN }}
          ref: ${{ github.event.client_payload.ref }}