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の請求ページでご確認ください。
関連記事
- CI分とは? GitHub Actionsの料金の仕組みCI分とは、パイプラインが使用する課金対象のコンピュート時間です。GitHub Actionsでの分の数え方、切り上げと乗数、そして使用量を減らす方法を説明します。
- GitHub Actionsのキャッシュキーとは?キャッシュキーとは、GitHub Actionsで保存されたキャッシュを識別する文字列です。キーとrestore-keysの仕組みを理解し、古いキャッシュを避ける方法を学びましょう。
- GitHub Actionsの同時実行グループとは?concurrency group は、キーごとに GitHub Actions のワークフローまたはジョブを一度に 1 つだけ実行させ、古い実行をキャンセルできるようにします。YAML の例と、よくある間違いを参照してください。
- 不安定なテストとは何か:定義と原因不安定なテストとは、コードに変更がないにもかかわらず、成功したり失敗したりするテストのことです。一般的な原因、CIでの検出方法、修正または隔離(クォランティン)の方法を解説します。