Eine der wichtigsten Aufgaben bei der Arbeit an jedem Projekt ist ein bequemes und zuverlässiges Deployment-System (Deployment). Deploy ermöglicht es Entwicklern, Aktualisierungen und Änderungen an einem laufenden Projekt einfach und schnell zu übertragen, ohne dass das System ausfällt und ausfällt. In diesem Artikel erfahren Sie, wie Sie ein Deploy mit GitHub einrichten, einer der beliebtesten Hosting– und Quellcodeverwaltungsplattformen.
GitHub ist ein Versionskontrollsystem, das die Möglichkeit bietet, Open-Source-Projekte zu speichern und zu verwalten. Es ermöglicht Entwicklern, gemeinsam an einem Projekt zu arbeiten und alle Änderungen am Projekt zu verfolgen. Dient zum Speichern des Quellcodes, zum Nachverfolgen von Fehlern, zum Überprüfen des Codes und zum Ausführen anderer Softwareentwicklungsaufgaben. Abgesehen von diesen Funktionen bietet GitHub jedoch eine automatische Deploy-Funktion, mit der Änderungen direkt nach dem Commit in den Hauptzweig des Projekts auf den Produktionsserver übertragen werden können.
Befolgen Sie einige einfache Schritte, um ein automatisches Deployment von GitHub zu konfigurieren. Zunächst müssen Sie das Continuous Integration (CI) -System konfigurieren, das für das automatische Testen und Bereitstellen des Projekts bei jeder Codeänderung verantwortlich ist. Sie müssen dann eine Konfigurationsdatei erstellen, in der alle Projektparameter und Deployment-Einstellungen angegeben werden. Jedes Mal, wenn ein Projekt auf GitHub aktualisiert wird, wird ein CI-System gestartet, das die erforderlichen Schritte ausführt und die laufende Version des Projekts aktualisiert. Der gesamte Prozess kann einfach konfiguriert und automatisiert werden, wodurch Entwickler Zeit und Aufwand sparen.
Guide: Einrichten eines Deployments mit GitHub für ein Projekt
Wenn Sie ein Projekt mit GitHub entwickeln, müssen Sie möglicherweise das automatische Deployment Ihres Projekts nach jeder Aktualisierung des Codes konfigurieren. Dies ist praktisch, um neue Versionen schnell bereitzustellen und aktuelle zu aktualisieren.
Befolgen Sie diese Schritte, um ein Deploy mit GitHub einzurichten:
- Erstellen Sie eine Bereitstellungsskriptdatei (z. B. deploy.sh ) im Stammordner Ihres Projekts. In dieser Datei können Sie die Befehle angeben, die bei der Bereitstellung ausgeführt werden sollen (z. B. das Erstellen eines Projekts, das Aktualisieren von Abhängigkeiten).
- Verwenden Sie den Befehl chmod +x, um die Bereitstellungsskriptdatei ausführbar zu machen deploy.sh .
- Erstellen Sie eine Deploy-Konfigurationsdatei (z. B. deploy.config) im Stammordner Ihres Projekts. In dieser Datei können Sie die Einstellungen für das Deployment angeben, z. B. den Pfad zum Remote-Server, den Benutzernamen und das Passwort.
- Fügen Sie die Bereitstellungsskript- und Deploy-Konfigurationsdateien Ihrem Repository auf GitHub hinzu.
- Öffnen Sie die Einstellungen Ihres Repositorys auf GitHub und gehen Sie zum Abschnitt "Aktionen".
- Klicken Sie auf die Schaltfläche "Neuer Workflow" und wählen Sie "Set up a workflow yourself".
- In der Workflow-Datei, die geöffnet wird.yaml Definieren Sie die Workfloweigenschaften (z. B. den Namen des Workflows, die Ereignisse, die das Deployment auslösen sollen), und fügen Sie einen Schritt hinzu, der Ihre Bereitstellungsskriptdatei ausführt.
- Speichern Sie die Workflow-Datei.yaml und zurück zur GitHub-Weboberfläche.
- Klicken Sie auf die Schaltfläche "Aktionen" und wählen Sie Ihren Workflow aus. Klicken Sie dann auf die Schaltfläche "Aktivieren", um den Workflow zu aktivieren.
- Jetzt wird GitHub bei jeder Aktualisierung des Codes in Ihrem Repository automatisch vom Deploy Ihres Projekts gestartet.
Dieser Leitfaden wird Ihnen helfen, das automatische Deployment Ihres Projekts mit GitHub einzurichten. Es ist ein praktisches Werkzeug, um Ihr Produkt schnell und zuverlässig zu aktualisieren.
Schritt 1: Erstellen eines Repositorys
Führen Sie die folgenden Schritte aus, um ein neues Repository zu erstellen:
| 1. | Besuchen Sie die GitHub-Startseite und melden Sie sich bei Ihrem Konto an. |
| 2. | Klicken Sie auf der Startseite auf die Schaltfläche "Neu" in der oberen linken Ecke. |
| 3. | Geben Sie im folgenden Fenster den Namen Ihres Repositorys in das Feld "Repository name" ein. |
| 4. | Optional können Sie im Feld "Description" (Beschreibung) eine Beschreibung des Repositorys hinzufügen. |
| 5. | Sie können die Einstellungen für "Öffentlich" belassen, damit das Repository für alle zugänglich ist, oder "Privat" auswählen, damit das Repository nur für Sie zugänglich ist. |
| 6. | Wenn Sie ein Repository mit "README" -, "Gitignore" - oder Lizenzdateien erstellen müssen, aktivieren Sie die entsprechenden Kontrollkästchen. |
| 7. | Klicken Sie auf "Create repository" (Repository erstellen), um den Erstellungsprozess abzuschließen. |
Glückwunsch! Sie haben erfolgreich ein Repository auf GitHub erstellt, das für Ihr Projekt verwendet wird.
Schritt 2: Einrichten von Webhooks
Um Ihr Projekt nach jedem Commit automatisch von GitHub abzulegen, müssen Sie Webhooks einrichten.
Webhooks ist der Mechanismus, mit dem GitHub Ihren Server über jedes neue Ereignis in Ihrem Repository benachrichtigt. In unserem Fall werden wir diesen Mechanismus verwenden, um den Commit zu benachrichtigen und den Deploy zu starten. Führen Sie die folgenden Schritte aus, um dies zu konfigurieren:
- Gehen Sie zu den Einstellungen Ihres Repositorys auf GitHub.
- Klicken Sie auf die Registerkarte "Webhooks".
- Klicken Sie auf den Button "Webhook hinzufügen".
- Geben Sie im Feld "Payload URL" die URL Ihres Servers ein, auf dem das Deploy ausgeführt werden soll.
- Wählen Sie den Ereignistyp aus, über den Sie Benachrichtigungen erhalten möchten, z. B. Commits.
- Klicken Sie auf "Add webhook", um die Einstellungen zu speichern.
Nach der Einrichtung von Webhooks erhält Ihr Server Benachrichtigungen zu jedem neuen Commit in Ihrem Repository. Auf Ihrem Server können Sie ein Skript konfigurieren, das nach Erhalt der Benachrichtigung als Deploy ausgeführt wird.
Stellen Sie sicher, dass Ihr Server ordnungsgemäß konfiguriert ist, um Warnungen von GitHub zu empfangen und zu verarbeiten, bevor Sie mit der Einrichtung des Deployments fortfahren.
Schritt 3: Einrichten des Deploy-Systems
Wenn Sie Ihr Projekt bereits auf GitHub haben, können Sie mit der Einrichtung des Deployment-Systems beginnen, um es bei jedem neuen Commit in Ihr Repository automatisch auf dem Server bereitzustellen.
Der erste Schritt bei der Einrichtung eines Deploy-Systems besteht darin, ein geeignetes Werkzeug auszuwählen. Es gibt viele Tools und Dienste, die die Funktionalität des automatischen Deployments eines Projekts auf den Server bereitstellen. Sie können eines davon auswählen oder ein eigenes Skript für das Deployment einrichten.
GitHub Actions ist eines der beliebtesten Werkzeuge für die Deploy-Konfiguration. Es bietet die Möglichkeit, eigene Workflows mit einer YAML-Konfiguration zu erstellen, um Aufgaben unter bestimmten Bedingungen automatisch auszuführen - in unserem Fall nach jedem neuen Commit im Repository auf GitHub. Sie können festlegen, dass alle erforderlichen Deployment-Schritte korrekt ausgeführt werden, z. B. das Klonen des Repositorys auf den Server, das Installieren von Abhängigkeiten, das Erstellen des Projekts und das Ausführen des Projekts.
Beispiel für die Konfiguration eines Deploy-Systems mit GitHub Actions:
name: Deploy to server
- name: Checkout repository
