【Github】Github Actions ～ プロパティ ～

Github

■ はじめに

Github Actions で 色々と切り替える必要があるので
そこで、今回は、プロパティについて、徐々にではあるが、
まとめていく

目次

【０】まとめ
【１】イベント
　１）github.event_name
　２）github.ref_name
【２】リポジトリ
　１）GITHUB_REF
【３】概要表示
　１）GITHUB_STEP_SUMMARY

【０】まとめ

# Push Event (プッシュ時) Pull Request Event (プルリク時)
1 $GITHUB_REF refs/heads/{BRANCH_NAME} refs/pull/{ISSUE_NUMBER}/merge
2 ${{ github.ref }} refs/heads/{BRANCH_NAME} refs/pull/{ISSUE_NUMBER}/merge
3 ${{ github.ref_name }} {BRANCH_NAME} (ブランチ名) {ISSUE_NUMBER}/merge
4 ${{ github.head_ref }} - {HEAD_BRANCH_NAME}
5 ${{ github.base_ref }} - {BASE_BRANCH_NAME}

【１】イベント

１）github.event_name

* イベントを取得

２）github.ref_name

* ワークフローの実行をトリガーしたブランチ

【２】リポジトリ

１）GITHUB_REF

* 現在実行中のGitリポジトリの
　ブランチ名、タグ名、またはプルリクエストブランチ名を表す

【３】概要表示

１）GITHUB_STEP_SUMMARY

* ワークフロー実行のサマリーページに表示

https://docs.github.com/ja/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary

      # ★これで、「summary」部分にテーブルで表示される
      - name: Demo for GITHUB_STEP_SUMMARY
        run: |
          echo "|Properties|Value|" >> $GITHUB_STEP_SUMMARY
          echo "|---|---|" >> $GITHUB_STEP_SUMMARY
          echo "|GitHub Ref|\`${{ github.ref }}\`|" >> $GITHUB_STEP_SUMMARY
          echo "|Commit Hash|\`${{ github.sha }}\`|" >> $GITHUB_STEP_SUMMARY

参考文献

https://docs.github.com/ja/actions/learn-github-actions/contexts
https://dev.classmethod.jp/articles/how-to-get-a-ref-branch-within-a-workflow-execution-in-github-actions/

関連記事

Github ～ 入門編 ～
https://dk521123.hatenablog.com/entry/2019/07/18/234652
Github Actions ～ 基礎知識編 ～
https://dk521123.hatenablog.com/entry/2021/11/04/142835
Github Actions ～ 入門編 ～
https://dk521123.hatenablog.com/entry/2022/06/16/151443
Github Actions ～ Python関連 ～
https://dk521123.hatenablog.com/entry/2022/06/21/143624
Github ～ Webhook 編 ～
https://dk521123.hatenablog.com/entry/2020/01/25/224402
Github Actions ～ Annotations / Matcher ～
https://dk521123.hatenablog.com/entry/2024/03/25/182153