githubアクションズでワークフロー用のyamlが認識されない

Question

githubアクションズでワークフロー用のyamlを登録しました（.github/workflows/xxxx.yml）。

onイベントとして「workflow_dispatch」を使っているのですが、githubにコミットしても「Actions」ページのAll workflowsに表示されません。
つまり、githubからワークフローが認識されていない状態です。

workflow_dispatchの部分を含む全文は以下のように書いています。

xxxx.yml

name: test-run
on:
  workflow_dispatch:
    inputs:
      select_type:
        description: 'Choose type'
        required: true
        default: 'a'
        type: choice
        options:
          - a
          - b

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3

      - name: Set up AWS CLI
        uses: aws-actions/configure-aws-credentials@v3
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ap-northeast-1

      - name: Invoke Lambda function
        env:
          LAMBDA_FUNCTION_NAME: test-func
        run: |
          aws lambda invoke --function-name $LAMBDA_FUNCTION_NAME --payload '{"type":"${{ inputs.select_type }}"}' --cli-binary-format raw-in-base64-out response.json

ちなみに、本ワークフローはmainブランチではなくdevelopブランチにコミットしています。

これまで、workflow_dispatchではなくpushイベントを使ったワークフローはいくつかコミットしていて認識されているのですが、workflow_dispatchを使ったものは初めてです。

All workflowsにリストアアップされ、test-runのワークフローを実行したいです。
当方のケースのようにAll workflowsに表示されないという場合、どのようなことが考えられますでしょうか。
改善ポイントなどアドバイス頂けますと助かります。

Answer 1

workflow_dispatchのトリガーは、「対象のYAMLファイルがデフォルトブランチに存在する」場合のみ表示されるようになっています。(参照)
特に変更しない場合は、mainがデフォルトブランチになっていることが多いため、mainブランチにプッシュすることで解決が可能です。

※リポジトリ運用上の問題がなければ、例えば「SettingsのDefault branch欄を対象ファイルが存在するブランチ」に切り替えることでも表示されるようにはなります。

Comments

[dev39]

ご丁寧な説明ありがとうございます！デフォルトブランチであることということは仕様上決まっていることなのですね。とても参考になりました。

Answer 2

mainブランチにプッシュしたらワークフローが認識されました。
mainブランチ以外では認識されないのか不明ですが、動いたので自己解決とさていただきます。