■ はじめに

https://dk521123.hatenablog.com/entry/2024/01/28/004128

の分冊。

Github Actions の if について、まとめる

【１】if
　１）演算子
【２】if の指定の種類
　１）jobs.<job_id>.if
　２）jobs.<job_id>.steps[*].if
【３】if に指定する主なイベント
　１）成功 - success()
　２）失敗 - failure()
　３）取り消し - cancelled()
　４）常時 - always()
　５）step時の結果イベント（steps.<step_id>.conclusion / steps.<step_id>.outcome）
【４】使用上の注意
　１）always() ではなく !cancelled() を使う
　２）if 内部の文字列は "" ではなく '' を使う
【５】サンプル
　例１：ファイルサイズを確認し、2000byte以下であれば中断する

【１】if

* if [条件] で、[条件] が真になった場合に実行する

https://docs.github.com/ja/actions/learn-github-actions/expressions#status-check-functions

１）演算子

Mark	Explanations
==	Equal
!=	Not equal
&&	And
｜｜	Or

サンプル

name: example-workflow
on: [push]
jobs:
  production-deploy:
    if: (github.repository == 'octo-org/octo-repo-prod') || (...)

【２】if の指定の種類

* if には、それぞれ「Job」と「Step」に対するものの2種類ある

１）jobs.<job_id>.if

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif

* Job に対して指定する

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-only-run-job-for-specific-repository

name: example-workflow
on: [push]
jobs:
  production-deploy:
    if: github.repository == 'octo-org/octo-repo-prod'
    runs-on: ubuntu-latest

２）jobs.<job_id>.steps[*].if

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsif

* Step に対して指定する

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-using-status-check-functions

steps:
  - name: My first step
    uses: octo-org/action-name@main
  - name: My backup step
    if: ${{ failure() }} # 失敗した時に実行
    uses: actions/heroku@1.0.0

【３】if に指定する主なイベント

１）成功 - success()

* これまでの手順がすべて成功した場合は true を返す

https://docs.github.com/ja/actions/learn-github-actions/expressions#success

if: ${{ success() }}

２）失敗 - failure()

* 失敗時

https://docs.github.com/ja/actions/learn-github-actions/expressions#failure

steps:
  ...
  - name: Failing step
    id: demo
    run: exit 1
  - name: The demo step has failed
    if: ${{ failure() && steps.demo.conclusion == 'failure' }}

３）取り消し - cancelled()

* ユーザ・キャンセル時

https://docs.github.com/ja/actions/learn-github-actions/expressions#cancelled

４）常時 - always()

* ステップが常に実行され、キャンセルされた場合でも true を返す

https://docs.github.com/ja/actions/learn-github-actions/expressions#always

if: ${{ always() }}

５）step時の結果イベント（steps.<step_id>.conclusion / steps.<step_id>.outcome）

* 以下の関連記事を参照のこと

https://dk521123.hatenablog.com/entry/2024/01/01/232057

例：Error handling

    steps:
      - id: demo-for-continue-on-error
        name: Demo for continue-on-error
        continue-on-error: true
        run: |
          mkdir test_dir
          # !ERROR due to duplicated directory
          mkdir test_dir
      # ★ここで改めてエラーハンドリング可能
      - id: demo-for-error-handling
        name: Demo for Error handling
        if: ${{ steps.demo-for-continue-on-error.outcome == 'failure' }}
        run: |
          echo "Error handling"
          exit 1

【４】使用上の注意

１）always() ではなく !cancelled() を使う

https://docs.github.com/ja/actions/learn-github-actions/expressions#always

より抜粋
~~~~~~~~~
警告：
成功または失敗に関係なくジョブまたはステップを実行する場合は、
推奨される代替手段 if: ${{ !cancelled() }} を使用してください
~~~~~~~~~

２）if 内部の文字列は "" ではなく '' を使う

if 内部の文字列は "" (ダブルクォーテーション) ではなく
'' （シングルクォーテーション）を使う

例

  - name: The demo step has failed
    if: ${{ github.ref_name == 'develop' }} # OK
    # if: ${{ github.ref_name == "develop" }} # NG

【５】サンプル

例１：ファイルサイズを確認し、2000byte以下であれば中断する

Github Actions ～ Python関連～
https://dk521123.hatenablog.com/entry/2022/06/21/143624

      # Wheelファイル作成およびファイルサイズをWHL_FILE_SIZEに格納
      - name: Run Python
        run: |
          python ./DemoLib/setup.py bdist_wheel
          cp ./dist/*.whl ./DemoLib/dist/*.whl
          echo "WHL_FILE_SIZE=$(wc -c ./dist/*.whl | awk '{print $1}')" >> $GITHUB_ENV
      # Wheelファイルサイズを確認（2000byte以下であれば中断）
      - name: File size check
        if: ${{ env.WHL_FILE_SIZE <= 2000 }}
        run: exit 1

プログラムの超個人的なメモ

Memo for Programming.

【Github】Github Actions ～ if ～

■ はじめに

目次

【１】if

１）演算子

【２】if の指定の種類

１）jobs.<job_id>.if

２）jobs.<job_id>.steps[*].if

【３】if に指定する主なイベント

１）成功 - success()

２）失敗 - failure()

３）取り消し - cancelled()

４）常時 - always()

５）step時の結果イベント（steps.<step_id>.conclusion / steps.<step_id>.outcome）

【４】使用上の注意

１）always() ではなく !cancelled() を使う

２）if 内部の文字列は "" ではなく '' を使う

【５】サンプル

例１：ファイルサイズを確認し、2000byte以下であれば中断する

関連記事