Abhängigkeiten für mehr Geschwindigkeit cachen

Ist Ihnen schon einmal aufgefallen, dass Ihr Workflow jedes Mal dieselben Abhängigkeiten erneut herunterlädt? Das verlangsamt die Ausführung!

Mit dem Caching in GitHub Actions können Sie Dateien aus früheren Ausführungen speichern und wiederverwenden. Dadurch werden nachfolgende Workflow-Ausführungen deutlich beschleunigt.

GitHub stellt eine spezielle Action namens actions/cache@v3 bereit. Diese Action wurde entwickelt, um Dateien zu speichern und wiederherzustellen und Ihre Workflows dadurch schneller zu machen.

Sie arbeitet intelligent: Bevor sie versucht, einen Cache wiederherzustellen, prüft sie, ob dieser bereits vorhanden ist, und speichert ihn, falls dies nicht der Fall ist.

Zwei entscheidende Parameter für actions/cache sind key und path:

• key: Eine eindeutige Zeichenfolge, die Ihren Cache identifiziert. Wenn ein Cache mit diesem Schlüssel gefunden wird, wird er wiederhergestellt.
• path: Die Dateipfade oder Verzeichnisse, die Sie cachen möchten. Damit legen Sie fest, *was* gespeichert oder wiederhergestellt werden soll.

Der Schlüssel enthält häufig einen Hash der Abhängigkeitsdateien. So wird sichergestellt, dass der Cache ungültig wird, sobald sich die Abhängigkeiten ändern.

Cachen ist nicht nur für Node.js gedacht! Sie können dasselbe Prinzip auch auf andere Sprachen wie Python anwenden. Hier cachen wir die virtuelle Umgebung von Python und den pip-Cache.

Der Schlüssel verwendet hashFiles, um auf Grundlage von package-lock.json einen dynamischen Schlüssel zu erstellen.

Versuchen Sie, diesen einfachen Workflow-Ausschnitt auszuführen:

Was ist, wenn Ihr exakter key mit keinem Cache übereinstimmt? Dann kommen restore-keys ins Spiel!

restore-keys stellt eine Liste von Fallback-Schlüsseln bereit, nach denen gesucht wird. Wenn der primäre Schlüssel (z. B. npm-${{ hashFiles(...) }}) nicht gefunden wird, versucht GitHub Actions, mithilfe der restore-keys in der angegebenen Reihenfolge einen Cache zu finden.

In unserem Beispiel sucht npm- nach einem beliebigen Cache, der mit „npm-“ beginnt. Das ist nützlich, wenn sich nur kleinere Abhängigkeitsversionen geändert haben.

Caching ist nicht nur für Node.js gedacht! Sie können dasselbe Prinzip auch auf andere Sprachen wie Python anwenden. Hier cachen wir die virtuelle Umgebung von Python und den pip-Cache.

Der Schlüssel verwendet hashFiles('requirements.txt'), und der Pfad verweist auf die virtuelle Umgebung sowie das Cache-Verzeichnis von pip.

Ein Cache ist nur dann nützlich, wenn er aktuell genug ist. Wenn sich Ihre Abhängigkeiten ändern, sollte sich auch Ihr Cache ändern!

Der Cache wird automatisch ungültig, wenn sich Ihr primärer key (z. B. npm-${{ hashFiles('package-lock.json') }}) ändert. Wenn package-lock.json aktualisiert wird, ändert sich der Hash und ein neuer Cache wird erstellt.

Sie können einen Cache auch erzwingen, indem Sie den Schlüssel manuell ändern, etwa durch das Hinzufügen eines Versionssuffixes wie npm-v2-${{ hashFiles(...) }}.

Es ist hilfreich zu wissen, wie Caching im Hintergrund funktioniert:

• Gültigkeitsbereich: Caches gelten pro Repository und pro Branch. Ein Cache im Branch main wird nicht in einem Feature-Branch verwendet, sofern Sie nicht ausdrücklich lookup-path konfigurieren.
• Größenlimit: Jeder Cache kann bis zu 10 GB groß sein.
• Aufbewahrung: Caches werden nach dem letzten Zugriff 7 Tage lang aufbewahrt. Alte, nicht verwendete Caches werden automatisch entfernt.

So holen Sie das Beste aus dem Caching heraus:

• hashFiles verwenden: Verknüpfen Sie Ihren Cache-Schlüssel stets mit Manifestdateien für Abhängigkeiten, etwa package-lock.json oder requirements.txt.
• Bei path genau sein: Cachen Sie nur, was notwendig ist, etwa node_modules oder ~/.cache/pip.
• restore-keys verwenden: Geben Sie Fallbacks an, um die Trefferquote des Caches zu erhöhen.
• Flüchtige Daten nicht cachen: Cachen Sie keine Dateien, die sich häufig ändern oder sehr groß und für jede Ausführung einzigartig sind, etwa für das Deployment vorgesehene Build-Artefakte.

Sie haben ein Java-Projekt, das Maven verwendet. Seine Abhängigkeiten sind in pom.xml definiert, und Maven speichert heruntergeladene JAR-Dateien normalerweise in ~/.m2/repository.

Welche Cache-Konfiguration stellt am besten sicher, dass Maven-Abhängigkeiten gecacht und bei Änderungen an pom.xml korrekt ungültig gemacht werden?

Sehr gut! Sie haben gelernt, wie Sie Caching in GitHub Actions implementieren, um Ihre CI/CD-Workflows deutlich zu beschleunigen.

• Die Action actions/cache ist Ihr Werkzeug dafür.
• Verwenden Sie key und path, um festzulegen, was und wie gecacht werden soll.
• hashFiles erstellt dynamische Schlüssel für eine intelligente Ungültigmachung.
• restore-keys stellt wertvolle Fallbacks bereit.

Indem Sie Abhängigkeiten intelligent cachen, sparen Sie Build-Zeit und Rechenressourcen und machen Ihre Pipelines effizienter!