GitHub Actionsで変数(githubなど)の値をデバッグする方法

Github Actionsで変数の値をデバッグする方法です。

方法は簡単で以下のコードをstepとして実行するだけとなります。

1
2
3
4
5


- name: Dump GitHub context
  env:
    GITHUB_CONTEXT: ${{ toJson(github) }}
  run: |
    echo "$GITHUB_CONTEXT"

実際に動作するコードは以下となります。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


name: CI

on: push

jobs:
  dump_variables:
    name: Dump variables
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Dump GitHub context
      env:
        GITHUB_CONTEXT: ${{ toJson(github) }}
      run: |
        echo "$GITHUB_CONTEXT"

上記コードにてGithub Actionsを実行することで、どのイベントでどういった値が参照可能か一目瞭然ですね。

これによりわざわざ公式ドキュメントのイベントごとに各イベントのAPIのページへいって、階層構造を気にしながらどういった値が取れるのか？という少し手間な確認作業が改善出来るかと思います。

お役に立てば幸いです。