コンテンツへスキップ

exit code 1で終了しました:デバッグ方法

最終更新:

Error: Process completed with exit code 1.は本当のエラーではありません。これは、runステップ内のコマンドがゼロ以外のステータスを返し、ステップが失敗したことをGitHubが知らせているものです。原因は、その上のログ行にあります。このページでは、それらの行の見つけ方、失敗の再現方法、そして最もよく見られる原因を説明します。

表示される正確なメッセージ

Error: Process completed with exit code 1.

終了コード1は、汎用的な「何か問題が起きた」というステータスです。多くのツールがこれを使用します。テストランナーはテストが失敗したとき、リンターは問題を検出したとき、grepは一致するものが見つからなかったとき、npmはスクリプトが失敗したときに使います。137、143、127、128などの他のコードには、より具体的な意味があります。

手順1:本当のエラーを見つける

失敗したステップを展開し、赤い行から上に向かって読んでいきます。エラーらしいメッセージ(スタックトレース、失敗したテスト、npm ERR!、error:)が最初に見つかれば、それが原因です。ログが長い場合は、ログビューアの検索ボックスでerror、fail、fatalを検索してください。

役立つ情報がない場合は、デバッグログを有効にしてください。ジョブを再実行し、「Enable debug logging」にチェックを入れるか、リポジトリのシークレットまたは変数ACTIONS_STEP_DEBUGをtrueに設定します。シェルステップでは、実行される各コマンドを表示させます。

- name: Build
  run: |
    set -x
    npm ci
    npm run build

手順2:GitHubがスクリプトをどのように実行するかを理解する

shell: bashを明示的に設定すると、GitHubはbash --noprofile --norc -eo pipefail {0}を実行します。Linuxでshellを設定しない場合は、bash -e {0}を実行します。どちらの場合も、最初に失敗したコマンドでステップは停止します。pipefailを使うと、パイプラインのどこかで失敗が起きてもステップ全体が失敗します。ステップの終了コードは、失敗したコマンドのコードです。

よくある原因と修正方法

1.テスト、リント、ビルドのコマンドが失敗した

最も一般的なケースです。ワークフローと同じNode、Python、Javaのバージョンを使い、同じコマンドをローカルで実行して、報告された問題を修正してください。

2.ロックファイルが一致しない

package-lock.jsonとpackage.jsonの内容が一致しないと、npm ciは終了コード1で失敗します。ローカルでnpm installを実行してロックファイルを再生成し、コミットしたうえで、CIと同じパッケージマネージャーのバージョンを使用してください。

3.grepやdiffが何も見つけなかった、または何かを見つけた

grepは一致するものがないと1で終了し、diffはファイルが異なると1で終了します。どちらも通常の結果ですが、ステップが失敗する原因になります。一致しないことが許容される場合は、そのように明示してください。

- run: grep -q "ready" status.txt || echo "not ready yet"

失敗が重要なコマンドの末尾に|| trueを付けないでください。本当のエラーが隠れてしまうためです。

4.環境変数またはシークレットが不足している

フォークから起動されたワークフローや、一部のDependabotの実行では、シークレットが空になります。そのため、それらを必要とするスクリプトが失敗します。値を表示せずに、設定されているかどうかを出力してください。

- run: test -n "$API_TOKEN" || { echo "API_TOKEN is empty"; exit 1; }
  env:
    API_TOKEN: ${{ secrets.API_TOKEN }}

5.ローカルでは動くのにCIでは動かない

ツールのバージョンの違い、オペレーティングシステムの違い、大文字と小文字を区別するファイル名などが原因になります。setup-node、setup-python、setup-javaでバージョンを固定し、インポートパスがファイル名の実際の大文字と小文字に一致しているか確認してください。

失敗が想定内の場合

ステップの失敗でジョブを失敗させたくない場合に限り、そのステップにcontinue-on-error: trueを使用してください。その結果は、後からsteps.<id>.outcomeで確認できます。

予防方法

  1. 同じバージョンを使って、同じコマンドをローカルで実行してください。理想的には、CIも呼び出す1つのスクリプトから実行するとよいでしょう。
  2. 変動するバージョンではなく、ランタイムとツールのバージョンを固定してください。
  3. 各ジョブの開始時に、失敗したツールのバージョンと作業ディレクトリを出力してください。
  4. ステップを小さく保つと、失敗したステップが問題を示してくれます。
  5. || trueで失敗を隠さないでください。

よくある質問

GitHub Actionsで終了コード1は何を意味しますか?

コマンドがステータス1を返したことを意味します。これは汎用的な失敗コードです。GitHubはそのステップを失敗としてマークします。何が問題だったのかは、そのメッセージの上の出力に書かれています。

「exit code 1」の上にエラーが見当たらないのはなぜですか?

ツールがエラーをファイルに出力したか、ログのグループが折りたたまれている可能性があります。すべてのグループを展開し、デバッグログを有効にしてから再実行してください。

終了コード1は0と同じですか?

いいえ。終了コード0は成功を意味します。それ以外のコードは、continue-on-errorを設定していない限り、ステップを失敗させます。

ステップで終了コード1を無視させることはできますか?

はい。continue-on-error: trueを使うか、スクリプト内でそのコマンドを処理することでできます。失敗が本当に問題にならない場合に限り、この方法を使ってください。