アクションの終了コードの設定

終了コードについて

GitHub では、終了コードを使用してアクションのチェック実行ステータスを設定します。ステータスは success か failure です。

終了ステータス	チェック実行ステータス	説明
0	success	アクションが正常に完了し、それに依存する他のタスクを開始できます。
ゼロ以外の値 (0 以外の任意の整数)	failure	その他の終了コードは、アクションの失敗を表します。 アクションが失敗すると、同時に実行されていたアクションはすべてキャンセルされ、今後のアクションはスキップされます。 チェック実行とチェック スイートの両方に failure ステータスが与えられます。

JavaScript アクションで失敗終了を設定する

JavaScript のアクションを作成する場合は、アクション ツールキット @actions/core パッケージを使用してメッセージをログに記録し、エラー終了コードを設定できます。 次に例を示します。

try {
  // something
} catch (error) {
  core.setFailed(error.message);
}

詳しくは、「JavaScript アクションを作成する」をご覧ください。

Docker コンテナアクションで失敗終了コードを設定する

Docker コンテナー アクションを作成する場合は、entrypoint.sh スクリプトにエラー終了コードを設定できます。 次に例を示します。

if <condition> ; then
  echo "Game over!"
  exit 1
fi

詳しくは、「Docker コンテナーのアクションを作成する」をご覧ください。