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

この記事では、次の� �目が扱われます。

終了コードを使って、アクションのステータスを設定できます。 GitHubは、パスした、あるいは失敗したアクションを示すステータスを表示します。

注: GitHub ホステッドランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

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

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

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

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

詳細については、「JavaScript アクションを作成する」を参照してく� さい。

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

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

詳細については、「Docker コンテナーアクションを作成する」を参照してく� さい。