GitHub Actions ist eine GitHub-Funktionalität, mit der Sie verschiedene Softwareentwicklungsprozesse automatisieren können. Eine der nützlichsten Funktionen von GitHub Actions ist die Möglichkeit, Code mithilfe verschiedener Dienste und Tools automatisch bereitzustellen. In diesem Artikel erfahren Sie, wie Sie ein Deploy über GitHub Actions von einem anderen Repository aus einrichten.
Die Vorteile der Verwendung von GitHub Actions für Deploy sind wie folgt:
- Einfach einzurichten und zu verwenden.
- Möglichkeit, die automatische Bereitstellung auf verschiedenen Hosting-Plattformen zu konfigurieren.
- Flexibilität und Anpassbarkeit des Deploy-Prozesses.
In diesem Artikel werden wir uns eine schrittweise Anleitung zum Einrichten eines Deployments von einem anderen Repository über GitHub Actions ansehen. Bevor Sie beginnen, müssen Sie über ein GitHub-Konto verfügen und Zugriff auf das Repository haben, in dem der Deploy stattfinden wird.
Jetzt können wir über GitHub Actions zum Deploy-Setup gehen. Wir haben einige Schritte, die wir befolgen müssen, um erfolgreich einzurichten:
Vorbereitung für die Einrichtung
Um ein Deploy über GitHub Actions von einem anderen Repository aus zu konfigurieren, müssen Sie einige Schritte ausführen.
Schritt 1: Erstellen Sie ein Repository auf GitHub, in dem Ihr Projekt gespeichert wird.
Schritt 2: Erstellen Sie ein separates Repository auf GitHub, in dem die Konfiguration für das Deployment gespeichert wird.
Schritt 3: Erstellen Sie in Ihrem Hauptprojekt eine Datei deploy.yml im Ordner .github/workflows. Diese Datei beschreibt die Konfiguration für das Deployment.
Schritt 4: In der Datei deploy.yml beschreiben Sie die Abfolge der Schritte, die Sie für eine erfolgreiche Deploy durchführen müssen.
Schritt 5: Erstellen Sie im Deployment-Konfigurations-Repository die Dateien, die Sie zum Ausführen der Schritte aus der Datei benötigen deploy.yml. Dies können Dateien mit Servereinstellungen, Skripts zum Erstellen des Projekts und andere Dateien sein, die für das Deployment benötigt werden.
Schritt 6: In der Datei deploy.yml fügen Sie die gewünschten Umgebungsvariablen hinzu, die während des Deployments verwendet werden sollen.
Schritt 7: Speichern Sie die Änderungen und fügen Sie sie in das Repository ein.
Schritt 8: Aktivieren Sie GitHub Actions in den Einstellungen Ihres Projekts auf GitHub.
Schritt 9: Gehen Sie zum Abschnitt Aktionen in Ihrem Repository und stellen Sie sicher, dass das Deploy erfolgreich ausgeführt wird.
Jetzt sind Sie bereit, das Deploy über GitHub Actions von einem anderen Repository aus einzurichten!
Installieren von Git
Folgen Sie den Anweisungen, die Ihrem Betriebssystem entsprechen, um Git auf Ihrem Computer zu installieren:
- Gehen Sie zur offiziellen Git-Website unter https://git-scm.com/download/win
- Laden Sie die Installationsdatei für Windows herunter, die der Bittiefe Ihres Betriebssystems entspricht (32-Bit oder 64-Bit)
- Führen Sie die heruntergeladene Installationsdatei aus, und folgen Sie den Anweisungen des Installationsassistenten
- Nach Abschluss der Installation wird Git in der Befehlszeile verfügbar sein
- Terminal öffnen
- Installieren Sie Homebrew, wenn es noch nicht auf dem Computer vorhanden ist, indem Sie den Befehl /bin/bash -c "$(curl -fsSL) ausführen https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh )"
- Installiere Git, indem du den folgenden Befehl ausführst: brew install git
- Nach Abschluss der Installation wird Git in der Befehlszeile verfügbar sein
- Terminal öffnen
- Installieren Sie Git, indem Sie den folgenden Befehl ausführen: sudo apt install git
- Nach Abschluss der Installation wird Git in der Befehlszeile verfügbar sein
Nach der Installation von Git können Sie mit den Repositories arbeiten und GitHub Actions verwenden, um den Deploy-Prozess zu automatisieren.
Anmeldung auf GitHub
Mit der Registrierung auf GitHub können Sie Projekte erstellen und an Projekten teilnehmen, Code teilen und mit anderen Entwicklern zusammenarbeiten. Um sich auf GitHub anzumelden:
- Öffnen Sie die GitHub-Website unter https://github.com /.
- Klicken Sie oben rechts auf der Seite auf die Schaltfläche "Anmelden".
- Füllen Sie alle erforderlichen Felder auf dem Anmeldeformular aus, einschließlich Benutzername, E-Mail-Adresse und Passwort.
- Wählen Sie einen Plan aus, der Ihren Bedürfnissen entspricht. GitHub bietet einen kostenlosen Plan für offene Projekte und bezahlte Pläne mit zusätzlichen Funktionen für die kommerzielle Nutzung.
- Führen Sie die Sicherheitsprüfung durch, indem Sie die entsprechende Option auswählen.
- Klicken Sie auf die Schaltfläche "Konto erstellen", um die Registrierung abzuschließen.
Nach erfolgreicher Registrierung steht Ihnen ein persönliches Profil auf GitHub zur Verfügung. Hier können Sie neue Repositories erstellen, Code herunterladen und mit anderen Entwicklern interagieren. Denken Sie daran, dass Sie bei der Registrierung einen eindeutigen Benutzernamen auswählen müssen, der Sie auf GitHub identifiziert.
Es wird auch empfohlen, die Zwei-Faktor-Authentifizierung zu aktivieren, um Ihr Konto vor unbefugtem Zugriff zu schützen. Weitere Informationen zum Einrichten und Verwenden von GitHub finden Sie auf der offiziellen Website und in der Dokumentation des Dienstes.
Nachdem Sie nun ein Konto auf GitHub haben, können Sie damit das Deploy über GitHub Actions von einem anderen Repository aus einrichten.
Einrichten von GitHub-Aktionen
Schritt 1: Erstellen einer Workflowdatei
Erstellen Sie eine neue Datei im Stammordner Ihres Repositorys mit dem Namen .github/workflows/main.yml . Diese Datei enthält Ihren Workflow.
Schritt 2: Ermitteln des Ereignisses, das den Workflow auslöst
Definieren Sie innerhalb der Workflowdatei das Ereignis, das Ihren Workflow auslöst. Sie können beispielsweise einen Workflow so konfigurieren, dass er bei jedem Push in das Repository ausgeführt wird.
name: Деплой на серверon:push:branches:- mainSchritt 3: Definieren von Workflowschritten
Definieren Sie die Schritte, die Sie in Ihrem Workflow ausführen müssen. Dies können Befehle sein, um Code zu kompilieren, die Anwendung zu testen oder auf den Server zu deploy.
jobs:deploy:runs-on: ubuntu-lateststeps:- name: Установка зависимостейrun: npm install- name: Компиляция кодаrun: npm build- name: Деплой на серверrun: ssh user@server 'bash -s' < deploy.shSchritt 4: Speichern und Push-Änderungen
Speichern Sie die Workflow-Datei und führen Sie den Befehl git push aus, um die Änderungen an GitHub zu senden. Danach startet GitHub Actions automatisch Ihren Workflow, wenn das in den Einstellungen angegebene Ereignis ausgeführt wird.
Jetzt haben Sie GitHub Actions für Ihr Repository eingerichtet! Sie können Ihren Workflow nach Belieben anpassen und ändern, neue Schritte hinzufügen oder Startbedingungen ändern.
Erstellen eines neuen Repositorys
Beginnen Sie damit, ein neues Repository auf der GitHub-Plattform zu erstellen. Führen Sie dazu die folgenden Schritte aus:
- Gehen Sie zu Ihrer GitHub-Profilseite und klicken Sie auf die Schaltfläche "Neu".
- Geben Sie einen Namen für das neue Repository ein und fügen Sie optional eine Beschreibung hinzu.
- Legen Sie die Einstellungen des Repositorys nach Belieben fest, z. B. indem Sie die Sichtbarkeit des Repositorys auf öffentlich oder privat festlegen.
- Fügen Sie optional eine Datei hinzu .gitignore, um bestimmte Dateien oder Ordner beim Kommentieren zu ignorieren.
- Wählen Sie optional eine Lizenz für Ihr Repository aus.
- Klicken Sie auf "Create repository" (Repository erstellen), um die Erstellung des neuen Repositorys abzuschließen.
Jetzt haben Sie ein neues Repository auf GitHub, mit dem Sie das Deployment über GitHub Actions konfigurieren können.
Konfigurieren von geheimen Variablen
Um GitHub Actions sicher zu verwenden und vertrauliche Informationen wie Zugriffstoken und Passwörter zu schützen, müssen Sie geheime Variablen im Repository konfigurieren.
Die Schritte zum Einrichten von geheimen Variablen sind wie folgt:
- Öffnen Sie die Seite Ihres Repositorys auf GitHub.
- Wählen Sie im Repository-Menü "Settings" aus.
- Wählen Sie auf der Seite "Settings" im linken Menü die Option "Secrets" aus.
- Klicken Sie auf die Schaltfläche "New secret", um eine neue geheime Variable hinzuzufügen.
- Geben Sie einen Variablennamen und einen Wert ein.
- Klicken Sie auf "Add secret", um die geheime Variable zu speichern.
Nachdem Sie die geheimen Variablen gespeichert haben, können Sie sie in Ihrer Workflowdatei verwenden, um Ihre Anwendung automatisch zu erstellen, zu testen und bereitzustellen. Geheime Variablen werden in Ihrem Arbeitsthread wie normale Umgebungsvariablen mit dem gleichen Namen verfügbar sein, den Sie bei Ihrer Erstellung angegeben haben.
Beachten Sie, dass die geheimen Variablen nur für Ihre Worker-Threads in diesem Repository verfügbar sind. Sie sind in den Aktionsprotokollen nicht sichtbar und werden nicht an Dritte weitergegeben.
Durch das Festlegen von geheimen Variablen können Sie vertrauliche Daten offen halten, während Sie gleichzeitig die Sicherheit Ihres Projekts und den Schutz privater Informationen gewährleisten.
Repository für Deploy einrichten
Um ein Deployment-Repository zu konfigurieren, führen Sie die folgenden Schritte aus:
- Erstellen Sie ein neues Repository auf der GitHub-Plattform, falls noch kein Repository vorhanden ist.
- Das Repository mit dem Befehl git clone auf die lokale Maschine zu lehnen.
- Datei erstellen .github/workflows/deploy.yaml im Stammordner des Repositorys.
- Öffnen Sie die Datei deploy.yaml in einem Texteditor und fügen Sie die erforderlichen Schritte zum Deploy hinzu.
- Speichern Sie die deploy-Datei.yaml .
- Die Änderungen im Repository auskommentieren und abspeichern.
- Öffnen Sie das Repository auf GitHub und gehen Sie zum Abschnitt Aktionen.
- Actions für das Repository aktivieren.
- Überprüfen Sie das Ergebnis der Registerkarte Aktionen und stellen Sie sicher, dass das Deploy erfolgreich ist.
Nachdem Sie diese Schritte ausgeführt haben, wird das Repository so konfiguriert, dass es automatisch über GitHub Actions deponiert wird. Jedes Mal, wenn Sie Änderungen an das Repository pushen, wird nun der in der Deploy-Datei angegebene Deploy-Prozess gestartet.yaml .
