コンテンツへスキップ

GitHub Actionsのアーティファクトとは

最終更新

GitHub Actionsのアーティファクトとは、ワークフロー実行で保存され、後続のジョブや利用者が使えるファイルまたはフォルダーです。代表的なものとして、ビルドの成果物、テストレポート、カバレッジファイル、エンドツーエンドテストが失敗したときのスクリーンショットがあります。

仕組み

アップロードにはactions/upload-artifactを、ダウンロードにはactions/download-artifactを使用します。各ジョブは新しいランナーで実行されるため、ビルドの成果物を次のジョブへ渡す標準的な方法がアーティファクトです。アップロードされたアーティファクトは、ワークフロー実行のページにも表示され、アクセス権のあるユーザーはzipファイルとしてダウンロードできます。

アーティファクトは単一のワークフロー実行に紐づき、保持期間が過ぎると期限切れになります。デフォルトの保持期間はリポジトリまたは組織の設定で決まり、各アップロードではretention-daysを指定して上書きできます。

アーティファクトアクションのバージョン4以降では、アーティファクト名は同じ実行内で一意である必要があります。同じ名前に2回アップロードすると、overwriteを設定しない限り失敗します。そのため、マトリックスジョブでは、マトリックスの値を含む名前を付ける必要があります。

例

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci && npm run build
      - uses: actions/upload-artifact@v4
        with:
          name: dist
          path: dist/
          retention-days: 7
          if-no-files-found: error

  deploy:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/download-artifact@v4
        with:
          name: dist
          path: dist/
      - run: ls dist

失敗した実行のレポートこそ必要になる場面なので、アップロードのステップにif: always()またはif: failure()を追加して、保存されるようにしてください。

アーティファクトとキャッシュの比較

アーティファクトキャッシュ
目的この実行の成果物今後の実行を高速化
対象範囲1回のワークフロー実行キーによって実行やブランチをまたいで共有
保持期間実行ごとに設定未使用時またはサイズ上限超過で削除
変更不可実行内の名前ごとキャッシュキーごと

来週再利用するためにnode_modulesを保存する場合はキャッシュを使ってください。デプロイのジョブにバイナリを渡す場合はアーティファクトを使ってください。詳しくはGitHub Actionsのキャッシュをご覧ください。

よくある間違い

  • アップロードしすぎる。大きなアーティファクトはジョブを遅くし、ストレージの容量を消費します。必要なものだけをアップロードしてください。
  • マトリックスジョブでの名前の衝突。名前に${{ matrix.os }}やシャード番号を含め、その後actions/upload-artifact/mergeで統合してください。
  • アーティファクトへのシークレットの混入。実行を読み取れる人は誰でもダウンロードできます。.envファイルや認証情報は決してアップロードしないでください。
  • アーティファクトをキャッシュとして使う。毎回再アップロードされるため、適切なキャッシュより遅くなります。
  • 保持期間を設定し忘れる。長いデフォルト値は、気づかないうちにストレージを消費します。

よくある質問

アーティファクトはどのくらい保存されますか?

設定された保持期間の間保存されます。変更していない場合、公開リポジトリのデフォルトは90日です。現在の値はリポジトリの設定で確認してください。

アーティファクトはワークフローをまたいで共有できますか?

はい、download-artifactでrun-idとトークンを指定するか、REST APIを使うことで共有できます。1回の実行内であれば簡単に扱えます。

アーティファクトには費用がかかりますか?

プランに含まれる量を超えたストレージは課金対象です。最新の料金は、GitHubの請求ページでご確認ください。