9  Workflow実行名の設定

github コンテキストを用いたWorkflow実行名の管理

GitHub では，リポジトリの [Actions] タブのワークフロー実行のリストにワークフロー実行名が表示されます． デフォルト(=run-nameキーが設定されていない)のワークフロー実行名は，ワークフロー実行のイベント固有の情報に設定されています．例として，

event	デフォルトワークフローネーム
push	コミットメッセージ
pull_request	pull requestのタイトル

Workflow実行名のカスタム

run-nameキーを設定することでGitHubのWorkflowログに現れるWorkflow実行名を設定することができます．

▶  例: pull request numberをworkflow名に表示する

pull request closed時に実行されるworkflow実行名を pull_request <issue-number> from <source-branch>という命名規則で運用したい場合を考えます．

コンテキスト変数	説明	例
github.event_name	ワークフローをトリガーしたイベント名	push, pull_request, schedule, workflow_dispatch
github.event.numbergithub.event.number	イベントトリガーがプルリクエストの場合，プルリクエストの番号	18
github.head_ref	ワークフローが実行されたブランチまたはプルリクエストのヘッドブランチ名	feature/new-feature

上記のコンテキスト変数を利用してWorkflowのrun-nameキーを設定する例として以下，

例: run-nameキーを用いたWorkflow実行名の設定

name: setup default shell name
run-name: "${{ github.event_name }} #${{ github.event.number }} from ${{ github.head_ref }}"
on:
  pull_request:
    branches: 
      - main
    types:
      - closed
defaults:
  run:
    shell: bash

jobs:
  print-status:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Pull Request" "#${{ github.event.number }} Merged"

Fig: run-nameキーを指定したときの実行結果