😺

GitHubActionsのデフォルト変数について

に公開
GitHub
githubaction
tech

はじめに

GithubActions実装の際にデフォルトで設定される変数について調査したのでこちらに残します。

デフォルトで設定される変数の紹介

GITHUB_TOKEN

https://docs.github.com/ja/actions/tutorials/authenticate-with-github_token

GithubActionsではPATを払い出して使うのではなく、あらかじめ設定されているGITHUB_TOKENというTokenを用いてGitHubに対して認証を行います。

ワークフロー内では以下のように設定します。
以下の設定を行うことでアプリケーションコードで環境変数(pythonならos.environ["GITHUB_TOKEN"])として読み込みます。

- name: example
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

権限はGUIまたはymlより変更可能です。

 permissions:
      contents: read
      pull-requests: write

GITHUB_REPOSITORY

https://docs.github.com/ja/actions/reference/workflows-and-actions/variables

Actionsを設定しているリポジトリ名を指定したい時はGITHUB_REPOSITORYを参照します。

- name: example
        env:
          GITHUB_REPOSITORY: ${{ github.repository }}

他の変数も上記リンクから確認できます。

  • GITHUB_REPOSITORY_ID
  • GITHUB_RUN_ID
  • RUNNER_NAME

他にもなどがあるようです。

参考

https://zenn.dev/moaikids/articles/10b8afb2c45c83

https://qiita.com/mkin/items/75a4928a1fafe5eacd17

Discussion