Zum Inhalt springen

Yarn-Abhängigkeiten in GitHub Actions cachen

Zuletzt aktualisiert am

Um Yarn in GitHub Actions zu cachen, setzen Sie cache: yarn bei actions/setup-node und installieren mit einer eingefrorenen Lockfile. Der Haken: Yarn Classic (1.x) und Yarn Berry (2+) speichern Pakete an unterschiedlichen Orten und verwenden unterschiedliche Flags, daher unterscheidet sich das explizite Rezept für beide.

Prüfen Sie zunächst, welche Version Sie haben: yarn --version gibt für Classic 1.22.x aus und für Berry 3.x oder 4.x.

Option 1: Integriertes Caching von setup-node

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - run: corepack enable          # needed for Berry and packageManager pinning
      - uses: actions/setup-node@v7
        with:
          node-version: 22
          cache: yarn
      - run: yarn install --immutable   # Berry
      # Classic: yarn install --frozen-lockfile
      - run: yarn test

Laut dem README von setup-node (geprüft im Oktober 2026) hasht cache: yarn standardmäßig yarn.lock, und der Paketmanager muss bereits installiert sein. corepack enable vor setup-node macht die Yarn-Version aus packageManager in package.json verfügbar. Bei mehreren Lockfiles verwenden Sie cache-dependency-path.

Option 2: explizites actions/cache für Classic

Classic hält einen globalen Cache. Fragen Sie ab, wo dieser liegt:

- uses: actions/setup-node@v7
  with:
    node-version: 22
- name: Get Yarn cache dir
  id: yarn-cache
  run: echo "dir=$(yarn cache dir)" >> "$GITHUB_OUTPUT"
- uses: actions/cache@v6
  with:
    path: ${{ steps.yarn-cache.outputs.dir }}
    key: yarn-classic-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
    restore-keys: |
      yarn-classic-${{ runner.os }}-
- run: yarn install --frozen-lockfile

Option 3: explizites actions/cache für Berry

Der Speicherort des Berry-Caches hängt von enableGlobalCache in .yarnrc.yml ab. Lesen Sie die tatsächliche Einstellung, statt sie anzunehmen:

- run: corepack enable
- uses: actions/setup-node@v7
  with:
    node-version: 22
- name: Get Yarn cache folder
  id: yarn-cache
  run: echo "dir=$(yarn config get cacheFolder)" >> "$GITHUB_OUTPUT"
- uses: actions/cache@v6
  with:
    path: ${{ steps.yarn-cache.outputs.dir }}
    key: yarn-berry-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
    restore-keys: |
      yarn-berry-${{ runner.os }}-
- run: yarn install --immutable

Wenn Ihr Repository nodeLinker: node-modules verwendet, liest die Installation weiterhin aus diesem Cache-Ordner und schreibt anschließend node_modules. Bei Plug'n'Play (der Standard) gibt es kein node_modules; Yarn schreibt .pnp.cjs und liest ZIP-Archive direkt.

Berry-Besonderheiten, die Sie kennen sollten

  • Zero-Install. Wenn Sie .yarn/cache in Git committen, enthält der Checkout die Pakete bereits. Es gibt dann nichts zu cachen; ein zusätzlicher Cache-Schritt erzeugt nur Mehraufwand. Der Kompromiss ist ein großes Repository.
  • Unveränderliche Installationen. yarn install --immutable schlägt fehl, wenn sich die Lockfile ändern würde, was in CI erwünscht ist. Berry kennt außerdem --immutable-cache, um bei einer Cache-Änderung abzubrechen.
  • Cache-Schlüssel. Fügen Sie runner.os hinzu. Berry-Cache-Archive können plattformspezifische Builds für Pakete mit nativen Bindings enthalten.

Warum nicht node_modules?

Aus demselben Grund wie in dem npm-Leitfaden: Eine frische Installation schreibt es neu, und native Module, die für eine Node-Version gebaut wurden, brechen mit einer anderen. Der Paket-Cache ist der Teil, der sicher wiederverwendet werden kann und schneller wiederhergestellt ist.

EinrichtungDiesen cachenInstallationsbefehl
Classic 1.xyarn cache diryarn install --frozen-lockfile
Berry, globaler Cacheyarn config get cacheFolderyarn install --immutable
Berry, Zero-Installnichts (committet)yarn install --immutable --immutable-cache

So überprüfen Sie einen Cache-Treffer

  1. Das Protokoll des Wiederherstellungsschritts zeigt Cache restored from key: ... bei einem Treffer und Cache not found for input keys: ... bei einem Fehlschlag.
  2. Bei Berry gibt die Installationsausgabe die Schritte Auflösung, Abruf und Verknüpfung mit Zeiten aus. Ein warmer Cache macht den Abrufschritt nahezu sofort fertig, während ein kalter Cache das Herunterladen von Paketen auflistet.
  3. Bei Classic wird eine warme Installation vom Verknüpfungsschritt dominiert; der Abrufschritt ist kurz.
  4. gh cache list --key yarn- --limit 20 bestätigt, was gespeichert wurde und wann es zuletzt verwendet wurde.

Häufige Fehler

  1. Falsche Datei hashen. package.json ändert sich häufiger als yarn.lock und macht den Cache unnötig ungültig. Hashen Sie die Lockfile.
  2. Corepack nicht aktivieren. Der Cache-Schritt von setup-node führt yarn aus; antwortet das falsche globale Yarn, ist das gemeldete Cache-Verzeichnis falsch.
  3. Ein Schlüssel für Classic und Berry. Wenn Sie migrieren, ändern Sie das Schlüssel-Präfix, damit das alte Layout nicht wiederhergestellt wird.
  4. Nur bei PRs cachen. Durch die Branch-Bindung werden PR-Caches nicht geteilt. Führen Sie den Workflow auch auf main aus. Siehe Caching in GitHub Actions.
  5. Die Größe ignorieren. Berry-Caches bestehen aus ZIP-Archiven und können in großen Monorepos einige GB erreichen. Behalten Sie das 10-GB-Limit im Blick.

FAQ

Unterstützt setup-node das Caching für Yarn Berry?

Ja, mit cache: yarn. Stellen Sie sicher, dass Corepack vor dem Setup-Schritt die richtige Yarn-Version aktiviert hat.

Sollte ich .yarn/cache committen (Zero-Install)?

Es entfällt der Cache-Schritt und die Netzwerkzeit für die Installation, dafür steigen die Repository-Größe und die unübersichtlichen Diffs. Das ist eine Teamentscheidung und keine CI-Vorgabe.

yarn install --immutable schlägt in der CI fehl. Warum?

Die Lockfile im Branch ist nicht mehr synchron mit package.json. Führen Sie yarn install lokal aus und committen Sie yarn.lock.

Unterscheidet sich das Yarn-Caching in einem Monorepo?

Workspaces teilen sich eine Lockfile und einen Cache-Ordner, daher ist das Rezept identisch. Verwenden Sie cache-dependency-path, wenn Sie mehr als eine Lockfile haben.

Nächste Schritte

Die Entsprechungen für pnpm und npm sowie wie Sie GitHub Actions beschleunigen finden Sie dort, was Sie nach dem Caching ausprobieren können. Um zu ermitteln, was eine bessere Trefferquote einspart, nutzen Sie den Cache-Einsparungsrechner.

Diesen Workflow auf compiler.dev ausführen Keine Karte nötig · 200 kostenlose Minuten

Kostenlos testen