Was ist act

act ermöglicht Entwicklern, ihre GitHub Actions Workflows lokal auszuführen, was schnelles Feedback liefert und den Entwicklungsprozess optimiert. Dieses Tool emuliert die GitHub Actions-Umgebung und ermöglicht es Benutzern, Workflows zu testen und zu debuggen, ohne Änderungen an einem Remote-Repository committen und pushen zu müssen. Im Gegensatz zum direkten Testen auf GitHub bietet act schnellere Iterationszyklen und reduziert die Zeit, die für das Warten auf CI/CD-Pipelines aufgewendet wird. Es nutzt Docker, um Aktionen auszuführen, und gewährleistet so die Konsistenz mit der GitHub-Umgebung. Entwickler profitieren von schnelleren Feedbackschleifen, einfacherem Debugging und der Möglichkeit, Aktionen direkt von ihrer bevorzugten IDE, wie z. B. VS Code, über Erweiterungen zu verwalten und auszuführen.

Hauptfunktionen von act

Lokale Workflow-Ausführung

Ermöglicht Entwicklern, GitHub Actions Workflows lokal auszuführen, wodurch das Pushen von Änderungen an ein Remote-Repository zum Testen entfällt. Dies reduziert die Feedbackschleifen erheblich und ermöglicht schnellere Iterationen und Debugging. Es emuliert die GitHub Actions-Umgebung und stellt sicher, dass sich Workflows lokal konsistent verhalten, wie sie es auf den Servern von GitHub tun würden.

Docker-basierte Ausführung

Nutzt Docker, um Aktionen auszuführen, und gewährleistet so eine konsistente und isolierte Umgebung, die die GitHub Actions-Laufzeitumgebung widerspiegelt. Dieser Ansatz garantiert, dass Abhängigkeiten und Konfigurationen korrekt verwaltet werden, wodurch Diskrepanzen zwischen lokaler und Remote-Ausführung verhindert werden. Es zieht oder erstellt Docker-Images, die in Ihren Workflow-Dateien definiert sind.

Umgebungsvariablen-Simulation

Bietet eine simulierte Umgebung, die die Umgebungsvariablen von GitHub widerspiegelt, einschließlich der Variablen, die sich auf das Repository, den Commit und den Runner beziehen. Dies stellt sicher, dass Workflows lokal auf dieselben Informationen zugreifen können wie auf GitHub, was das genaue Testen und Debuggen von bedingter Logik und Integrationen erleichtert.

VS Code-Integration

Bietet eine Integration mit Visual Studio Code über eine dedizierte Erweiterung. Diese Integration ermöglicht es Entwicklern, Workflows direkt von ihrem Editor auszuführen und zu testen, was eine nahtlose Entwicklungserfahrung bietet. Es vereinfacht den Prozess der Iteration von Workflows und reduziert den Kontextwechsel.

Unterstützung für benutzerdefinierte Container-Engine

Ermöglicht es Benutzern, eine benutzerdefinierte Container-Engine anzugeben, was Flexibilität bei der Verwaltung der Ausführungsumgebung bietet. Dies ist besonders nützlich für Benutzer, die spezifische Anforderungen haben oder eine andere Container-Engine als die Standard-Docker verwenden möchten. Es unterstützt verschiedene Container-Engines durch Konfiguration.

GitHub Enterprise-Unterstützung

Unterstützt GitHub Enterprise und ermöglicht es Benutzern, Workflows lokal für Repositories auszuführen, die auf ihren privaten GitHub Enterprise-Instanzen gehostet werden. Dies ist entscheidend für Organisationen, die GitHub Enterprise für ihre Entwicklungs- und CI/CD-Pipelines verwenden, da sie so Workflows in einer sicheren und kontrollierten Umgebung testen und debuggen können.

Wie man act verwendet

Installation: Installieren Sie act mit Ihrem bevorzugten Paketmanager (z. B. brew install act für Homebrew unter macOS, oder befolgen Sie die Anweisungen auf der Website für andere Plattformen).,2. Navigieren Sie zu Ihrem Repository: Wechseln Sie Ihr Verzeichnis zum Stamm Ihres Git-Repositorys, das das Verzeichnis .github/workflows enthält.,3. Führen Sie einen Workflow aus: Führen Sie einen bestimmten Workflow mit dem Befehl act -W .github/workflows/<your_workflow_file.yml> aus. Ersetzen Sie <your_workflow_file.yml> durch den tatsächlichen Dateinamen Ihres Workflows.,4. Geben Sie einen Job an: Zielen Sie auf einen bestimmten Job innerhalb eines Workflows, indem Sie den Jobnamen zum Befehl hinzufügen: act -W .github/workflows/<your_workflow_file.yml> -j <job_name>.,5. Ausgabe anzeigen: Beobachten Sie die Ausgabe in Ihrem Terminal, die den GitHub Actions Runner simuliert, einschließlich Protokollen, Umgebungsvariablen und allen generierten Artefakten.,6. Passen Sie die Umgebung an: Verwenden Sie das Flag -e, um Umgebungsvariablen an die Aktionen zu übergeben, oder verwenden Sie das Flag -s, um Geheimnisse bereitzustellen.

Anwendungsfälle von act

Workflow-Debugging

Softwareentwickler können act verwenden, um komplexe Workflows lokal zu debuggen. Sie können jede Aktion durchlaufen, Protokolle einsehen und Konfigurationen ändern, ohne Änderungen zu committen. Dies beschleunigt den Debugging-Prozess und reduziert die Zeit, die für die Fehlerbehebung in Remote-CI/CD-Pipelines aufgewendet wird.

CI/CD-Entwicklung

Entwickler können act verwenden, um neue CI/CD-Workflows zu entwickeln und zu testen, bevor sie in der Produktion bereitgestellt werden. Sie können mit verschiedenen Konfigurationen experimentieren, Integrationen testen und das Verhalten ihrer Workflows lokal validieren, um sicherzustellen, dass sie vor der Bereitstellung korrekt funktionieren.

Lokales Testen von Aktionen

Maintainer von benutzerdefinierten GitHub Actions können act verwenden, um ihre Aktionen lokal zu testen. Sie können verschiedene Eingaben simulieren, verschiedene Szenarien testen und sicherstellen, dass sich ihre Aktionen wie erwartet verhalten. Dies verbessert die Qualität und Zuverlässigkeit benutzerdefinierter Aktionen, bevor sie veröffentlicht werden.

Schnellere Iteration bei Workflow-Änderungen

Entwickler können act verwenden, um Änderungen an ihren Workflow-Dateien schnell zu iterieren. Anstatt auf einen vollständigen CI/CD-Lauf zu warten, können sie ihre Änderungen lokal testen und sofortiges Feedback erhalten. Dies beschleunigt den Entwicklungsprozess erheblich und steigert die Produktivität.

Wer profitiert von act

Softwareentwickler

Softwareentwickler profitieren von act, indem sie ihre GitHub Actions Workflows schnell lokal testen und debuggen können, wodurch die Zeit, die für das Warten auf CI/CD-Pipelines aufgewendet wird, reduziert und die allgemeine Entwicklungseffizienz verbessert wird.

DevOps-Ingenieure

DevOps-Ingenieure können act verwenden, um CI/CD-Pipelines lokal zu entwickeln und zu validieren, um sicherzustellen, dass Workflows korrekt konfiguriert sind und wie erwartet funktionieren, bevor sie in Produktionsumgebungen bereitgestellt werden.

CI/CD-Spezialisten

CI/CD-Spezialisten können act nutzen, um komplexe Workflows zu testen und Fehler zu beheben und sicherzustellen, dass alle Aspekte des CI/CD-Prozesses korrekt und effizient funktionieren.

Open-Source-Mitwirkende

Open-Source-Mitwirkende können act verwenden, um Projekte zu testen und zu diesen beizutragen, die GitHub Actions verwenden. Dies ermöglicht es ihnen, ihre Änderungen schnell zu validieren und die Kompatibilität mit dem CI/CD-Setup des Projekts sicherzustellen.