Zum Inhalt springen

Was ist ein Artifact in GitHub Actions?

Zuletzt aktualisiert am

Ein Artifact in GitHub Actions ist eine Datei oder ein Ordner, den ein Workflow-Lauf speichert, damit spätere Jobs oder Personen ihn verwenden können. Typische Artifacts sind Build-Ergebnisse, Testberichte, Coverage-Dateien und Screenshots von fehlgeschlagenen End-to-End-Tests.

So funktioniert es

Sie laden mit actions/upload-artifact hoch und mit actions/download-artifact herunter. Da jeder Job auf einem neuen Runner läuft, sind Artifacts der Standardweg, Build-Ergebnisse von einem Job an den nächsten weiterzugeben. Hochgeladene Artifacts erscheinen außerdem auf der Seite des Workflow-Laufs, wo alle mit Zugriff sie als ZIP-Datei herunterladen können.

Artifacts gehören zu einem einzelnen Workflow-Lauf und verfallen nach einer Aufbewahrungsfrist. Der Standardwert wird auf Repository- oder Organisationsebene festgelegt und kann pro Upload mit retention-days überschrieben werden.

Seit Version 4 der Artifact-Actions müssen Artifact-Namen innerhalb eines Laufs eindeutig sein. Ein zweiter Upload unter demselben Namen schlägt fehl, sofern Sie nicht overwrite setzen. Matrix-Jobs brauchen daher einen Namen, der den Matrix-Wert enthält.

Beispiel

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

Fügen Sie if: always() oder if: failure() zum Upload-Schritt hinzu, um Berichte fehlgeschlagener Läufe zu behalten, also genau dann, wenn Sie sie am meisten brauchen.

Artifacts im Vergleich zu Caches

ArtefaktCache
ZweckErgebnis dieses LaufsKünftige Läufe beschleunigen
UmfangEin Workflow-LaufÜber Läufe und Branches hinweg per Schlüssel geteilt
AufbewahrungPro Lauf festgelegtEntfernt, wenn ungenutzt oder über dem Größenlimit
UnveränderlichPro Name in einem LaufPro Cache-Schlüssel

Wenn Sie node_modules speichern wollen, um sie nächste Woche wiederzuverwenden, nutzen Sie einen Cache. Wenn Sie dem Deploy-Job ein Binary übergeben, nutzen Sie ein Artifact. Siehe GitHub Actions Caching.

Häufige Fehler

  • Zu viel hochladen. Große Artifacts verlangsamen Jobs und zählen auf das Speicherkontingent. Laden Sie nur hoch, was benötigt wird.
  • Namenskonflikte in Matrix-Jobs. Nehmen Sie ${{ matrix.os }} oder die Shard-Nummer in den Namen auf und führen Sie die Artifacts danach mit actions/upload-artifact/merge zusammen.
  • Secrets in Artifacts. Jeder, der den Lauf lesen kann, kann sie herunterladen. Laden Sie niemals .env-Dateien oder Zugangsdaten hoch.
  • Artifacts als Cache verwenden. Sie werden bei jedem Lauf neu hochgeladen und sind langsamer als ein richtiger Cache.
  • Aufbewahrung vergessen. Lange Standardwerte belegen still Speicherplatz.

FAQ

Wie lange werden Artifacts aufbewahrt?

Für die konfigurierte Aufbewahrungsfrist, standardmäßig 90 Tage für öffentliche Repositories, sofern nicht geändert. Den aktuellen Wert finden Sie in den Repository-Einstellungen.

Können Artifacts zwischen Workflows geteilt werden?

Ja, mit download-artifact unter Angabe der run-id und eines Tokens oder über die REST-API. Innerhalb eines Laufs ist es einfach.

Kosten Artifacts Geld?

Speicher über die im Tarif enthaltene Menge hinaus wird berechnet. Die aktuellen Preise finden Sie auf der Abrechnungsseite von GitHub.