ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

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

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

GitHub ActionsはGitHub Free、GitHub Pro、GitHub FreeのOrganization、GitHub Team、GitHub Enterprise Cloud、GitHub Oneで利用できます。 GitHub Actionsは、レガシーのリポジトリごとのプランを使っているアカウントが所有しているプライベートリポジトリでは利用できません。 詳しい情報については「GitHubの製品」を参照してください。

ここには以下の内容があります:

終了コードについて

GitHub uses the exit code to set the action's check run status, which can be success or failure.

終了ステータスチェック実行ステータス説明
0successアクションが正常に完了し、それに依存する他のタスクを開始できます。
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 コンテナアクションを作成する」を参照してください。

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください