GitHub Actions ist ein leistungsfähiges Tool, mit dem Sie verschiedene Aufgaben im Softwareentwicklungsprozess automatisieren können. Sie ermöglichen es Ihnen, Skripts auszuführen, Ihren Code zu testen, zu erstellen und im Repository bereitzustellen. Sie können verwendet werden, um den Entwicklungsprozess zu vereinfachen und die Codequalität zu verbessern.
Um Actions in Ihr Repository auf GitHub aufzunehmen, müssen Sie eine Datei "main" erstellen.yml" im Ordner .github/workflows Ihres Repositorys. In dieser Datei definieren Sie eine Reihe von Aufgaben, die Sie ausführen möchten, wenn Ereignisse in Ihrem Repository ausgelöst werden, z. B. das Erstellen, Ändern oder Löschen von Pool-Requests, Commits oder Tags.
Die Datei main.yml muss in der YAML-Markup-Sprache geschrieben sein, mit der Sie Ihren Workflow für GitHub Actions definieren können. In der Datei können Sie die verschiedenen Schritte und Schritte definieren, die ausgeführt werden, wenn Ihr Ereignis ausgelöst wird. Sie können beispielsweise Schritte zum Erstellen Ihres Projekts definieren, Tests ausführen oder Ihren Code bereitstellen.
Nachdem Sie die Main-Datei erstellt haben.yml und die Definition Ihres Workflows hinzugefügt, lesen und führen Actions Ihre Aktionen automatisch aus, wenn die entsprechenden Ereignisse ausgelöst werden. Sie können die Ausführung Ihrer Aktionen auf der Registerkarte Aktionen auf der Seite Ihres Repositorys überprüfen. Dort können Sie den Ausführungsverlauf aller Ihrer Aktivitäten sowie detaillierte Berichte und Ausführungsprotokolle sehen.
Einstellungen festlegen
Um actions in Ihr GitHub-Repository aufzunehmen, müssen Sie einige einfache Schritte ausführen:
1. Gehen Sie zu Ihrer Repository-Seite auf GitHub und wählen Sie den Abschnitt "Aktionen" in der oberen Navigationsleiste aus.
2. Klicken Sie auf die Schaltfläche "Set up a workflow yourself" oder wählen Sie eine der vordefinierten Vorlagen aus.
3. Erstellen Sie eine Datei mit der actions-Konfiguration, nennen Sie sie. "github/workflows/main.yml" und fügen Sie die gewünschten Aktionen in dieser Datei hinzu. Zum Beispiel:
name: CIon:push:branches:- mainjobs:build:runs-on: ubuntu-lateststeps:- name: Checkout repositoryuses: actions/checkout@v2- name: Install dependenciesrun: npm install- name: Run testsrun: npm test- name: Buildrun: npm run build- name: Deploy to productionuses: actions/aws@v2with:accessKeyId: $>secretAccessKey: $>region: us-east-1bucket: my-bucket4. Speichern Sie die Datei und speichern Sie sie in Ihrem GitHub-Repository.
Jetzt ist Ihr Repository für die Verwendung von actions konfiguriert. GitHub führt automatisch einen von Ihnen angegebenen Satz von Aktionen aus, wenn bestimmte Ereignisse ausgeführt werden, z. B. Push in ein Repository oder das Erstellen einer Pull-Anforderung.
Erstellen von workflows
Um einen Workflow zu erstellen, müssen Sie eine Datei namens name erstellen.yml im Ordner .github/workflows Ihres Repositorys. Die Datei sollte Informationen zu den Ereignissen enthalten, die der Workflow auslösen soll, und eine Liste der auszuführenden Aktionen.
Hier ist ein Beispiel für einen einfachen Workflow:
name: Mein erster Workflow on: push: branches: - main jobs: build: runs-on: ubuntu-latest steps: - name: Repository-Checkout uses: actions/checkout@v2 - name: Abhängigkeiten installieren run: npm install - name: Projekt erstellen run: npm build - name: Tests ausführen run: npm test
In diesem Beispiel wird der Workflow bei jedem Push in die Main-Verzweigung verwendet. Es führt Schritte aus, z. B. das Einchecken eines Repositorys mit der Aktion actions/checkout , das Installieren von Abhängigkeiten, das Erstellen eines Projekts und das Ausführen von Tests.
Nachdem Sie die Workflow-Datei erstellt haben, wird sie von GitHub automatisch ausgeführt, wenn die entsprechenden Ereignisse eintreten. Sie können den Fortschritt des Workflows verfolgen und die Protokolle und Ergebnisse von Aktionen auf der Registerkarte Aktionen Ihres Repositorys anzeigen.
Das Erstellen von Workflows ist ein leistungsfähiges Werkzeug, um die Entwicklungsprozesse in Ihrem Projekt auf GitHub zu automatisieren. Sie helfen Ihnen, Ihren Workflow zu vereinfachen, die Entwicklung zu beschleunigen und die Qualität Ihres Codes zu verbessern.
Ereignisse gestalten
Das Ereignis kann mit einem speziellen Skript namens "Workflow" behandelt werden. Ein Workflow ist ein Satz von Anweisungen, die ausgeführt werden, wenn ein bestimmtes Ereignis eintritt. Es beschreibt, welche Aktionen durchgeführt werden müssen und in welcher Reihenfolge.
Das Generieren von Ereignissen erfolgt durch Erstellen einer "Workflow" -Datei in einem speziellen Verzeichnis. "github" im Stammverzeichnis des Repositorys. In dieser Datei geben wir an, welche Ereignisse verarbeitet werden, welche Aktionen ausgeführt werden sollen, und andere Parameter. Nachdem die Workflow-Datei erstellt und gespeichert wurde, erkennt GitHub sie automatisch und beginnt mit der Verarbeitung der darin angegebenen Ereignisse.
In der Workflow-Datei können wir verschiedene Parameter angeben, z. B. den Namen des Workflows, die Ereignisse, unter denen er ausgeführt werden soll, die Bedingungen, unter denen er erfüllt werden soll, und andere. Wir können auch eine Liste der Aktionen angeben, die ausgeführt werden sollen, wenn ein Ereignis eintritt. Sie können für jede Aktion verschiedene Parameter und Einstellungen festlegen, z. B. Befehle, die ausgeführt werden sollen, ihre Reihenfolge, Umgebungsvariablen und andere.
Das Generieren von Ereignissen umfasst daher das Erstellen einer Workflowdatei mit den erforderlichen Parametern und Aktionen, die ausgeführt werden sollen. Danach fängt GitHub die angegebenen Ereignisse automatisch ab und führt die im Workflow beschriebenen Aktionen aus.
Verwenden von environment
Mit GitHub Actions können Sie die Umgebung steuern, in der Aktionen ausgeführt werden. Dies ist nützlich, wenn Sie Codeausführungsbedingungen basierend auf verschiedenen Faktoren wie dem Betriebssystem, der Sprachversion, der installierten Software und anderen überprüfen und verwalten müssen.
Die Umgebung wird mithilfe der environment-Datei definiert.yml, das sich in Ihrem Repository befinden sollte. In dieser Datei können Sie alle erforderlichen Abhängigkeiten und Einstellungen für Ihre Aktion angeben. Sie können beispielsweise die gewünschte Version einer Programmiersprache angeben, eine bestimmte Software installieren oder Umgebungsvariablen konfigurieren.
Beispieldatei environment.yml:
name: Pythonchannels:- conda-forgedependencies:- python=3.8- numpyIn diesem Beispiel ist die Datei environment.yml gibt eine Umgebung mit dem Namen "Python" an, in der der Kanal "conda-forge" verwendet wird und die Python-Pakete Version 3.8 und numpy installiert werden.
Die in der environment-Datei definierte Umgebung.yml kann in Aktionen mit dem Schlüsselwort "env" verwendet werden. Zum Beispiel:
steps:- name: Set up Python environmentuses: actions/setup-python@v2with:python-version: '3.8'env:PYTHONPATH: $>/srcIn diesem Beispiel ist die Python 3-Umgebung.8 wird mit der Aktion "actions/setup-python@v2" installiert. Die Umgebungsvariable PYTHONPATH wird ebenfalls festgelegt, um den Pfad zum Ordner "src" im Arbeitsverzeichnis des Repositorys anzugeben.
Die Verwendung einer Umgebung hilft dabei, flexiblere und vielseitigere Aktivitäten zu schaffen, die in einer Vielzahl von Umgebungen und Umgebungen funktionieren können.
Wie man Rauten einrichtet
Um das Rauten in GitHub Actions zu konfigurieren, müssen Sie eine Datei mit den Rauteneinstellungen erstellen. Diese Datei enthält Informationen darüber, welche Aktionen als Reaktion auf bestimmte Ereignisse ausgeführt werden sollen.
1. Erstellen Sie eine neue Datei im Stammordner Ihres Repositorys und benennen Sie sie .github/workflows/routing.yml . Sie können einen anderen Namen auswählen, aber es ist wichtig, dass sich die Datei in einem Ordner befindet .github/workflows/ .
2. Öffnen Sie die erstellte Datei im Code-Editor, und geben Sie den folgenden Code ein:
name: Routingon:push:branches:- mainpull_request:branches:- main
In diesem Beispiel haben wir das Rauten für Push- und pull_request-Ereignisse nur für den Main-Zweig konfiguriert. Sie können das Rauten für alle anderen Ereignisse und Zweige konfigurieren, indem Sie sie zu den entsprechenden Abschnitten hinzufügen.
3. Nachdem Sie die Ereignisse und Zweige konfiguriert haben, können Sie die Aktionen hinzufügen, die ausgeführt werden sollen. Sie können beispielsweise eine Aktion hinzufügen, um Tests auszuführen, ein Projekt zu erstellen und auf dem Server bereitzustellen:
jobs:test:runs-on: ubuntu-lateststeps:- name: Checkout codeuses: actions/checkout@v2- name: Run testsrun: npm testbuild:runs-on: ubuntu-latestneeds: teststeps:- name: Checkout codeuses: actions/checkout@v2- name: Build projectrun: npm run builddeploy:runs-on: ubuntu-latestneeds: buildsteps:- name: Checkout codeuses: actions/checkout@v2- name: Deploy to serverrun: ssh deploy@server 'cd /path/to/project && git pull'
In diesem Beispiel haben wir drei Aktionen erstellt: test , build und deploy . Sie werden als Reaktion auf Push- und pull_request-Ereignisse im main-Zweig nacheinander ausgeführt. Die Test-Aktion testet den Code, die build-Aktion erstellt das Projekt und die Deploy-Aktion stellt das Projekt auf dem Server bereit.
4. Speichern Sie die Änderungen in der Routing-Datei.yml und kommentieren Sie sie in Ihrem Repository auf GitHub.
Ihr Rauten ist jetzt eingerichtet und wird automatisch als Reaktion auf bestimmte Ereignisse ausgelöst. Sie können Aktivitäten in Ihrer Rautendatei je nach Ihren Bedürfnissen hinzufügen und ändern.
Umgang mit Geheimnissen
Wenn Sie mit dem Actions-Block auf GitHub arbeiten, können Sie Geheimnisse verwenden, um vertrauliche Informationen wie Passwörter, API-Token oder Datenbankzugriffsschlüssel zu speichern.
Geheimnisse sind verschlüsselte Daten, die nur für Ihr Konto verfügbar sind und von anderen Projektteilnehmern nicht angezeigt oder geändert werden können.
Um Geheimnisse in Ihrem Workflow zu verwenden, müssen Sie sie den Repository-Einstellungen hinzufügen. Gehen Sie dazu zu Ihrem Repository, wählen Sie den Abschnitt "Einstellungen" aus und klicken Sie dann auf die Registerkarte "Geheimnisse".
Auf der Seite mit den geheimen Einstellungen können Sie einen neuen geheimen Wert hinzufügen, indem Sie seinen Namen und seine Bedeutung angeben. Nach dem Speichern sind die geheimen Werte in Ihrem Workflow nach Namen verfügbar.
Um ein Geheimnis zu verwenden, fügen Sie seinen Namen zu Ihrer Workflow-Datei hinzu, umgeben von doppelten geschweiften Klammern. Wenn Sie beispielsweise ein Geheimnis mit dem Namen "API_TOKEN" hinzugefügt haben, um es im Workflow zu verwenden, können Sie die folgende Syntax verwenden:
steps:- name: Example steprun: echo $>Dadurch können Sie den Wert des Geheimnisses in Ihrem Workflow verwenden, ohne seinen Wert explizit in der Datei angeben zu müssen.
