Einführung und Einrichtung von GitHub Actions

Einführung

GitHub Actions ist eine Continuous Integration- und Continuous Delivery (CI/CD)-Plattform, mit der Sie Ihre Build-, Test- und Bereitstellungspipeline automatisieren können. Sie können Workflows erstellen, die jeden Pull Request für Ihr Repository bauen und testen oder zusammengeführte Pull Requests in die Produktion bereitstellen.

In diesem Lab lernen Sie die anfängliche Einrichtung kennen, die erforderlich ist, um mit der Nutzung von GitHub Actions zu beginnen. Sie durchlaufen den Prozess der Erstellung eines GitHub-Repositorys, des Klonens auf Ihre lokale Entwicklungsumgebung und der Einrichtung der spezifischen Verzeichnisstruktur, die GitHub Actions benötigt, um Ihre Workflows zu erkennen.

Voraussetzungen

• Ein GitHub-Konto (https://github.com). Wenn Sie noch kein GitHub-Konto besitzen, müssen Sie sich zuerst unter https://github.com/signup für ein kostenloses Konto registrieren. Dies ist eine Voraussetzung für die Durchführung dieses Labs.
• Grundlegende Vertrautheit mit der Kommandozeile (Command Line).

Neues Repository auf der GitHub-Website erstellen

In diesem Schritt erstellen Sie ein neues Repository auf der GitHub-Website. Dieses Repository dient als Remote-Speicherort für Ihr Projekt und als Ort, an dem GitHub Actions Workflows ausgeführt werden.

1. Öffnen Sie Ihren Webbrowser und navigieren Sie zu https://github.com.
2. Melden Sie sich bei Ihrem GitHub-Konto an.
3. Klicken Sie in der oberen rechten Ecke einer beliebigen Seite auf das Dropdown-Menü + und wählen Sie New repository (Neues Repository).
4. Geben Sie in das Feld Repository name (Repository-Name) github-actions-demo ein.
5. Wählen Sie Public (Öffentlich) (GitHub Actions ist für öffentliche Repositories kostenlos).
6. Aktivieren Sie das Kontrollkästchen Add a README file (Eine README-Datei hinzufügen). Dadurch wird sichergestellt, dass das Repository initialisiert und zum Klonen bereit ist.
7. Klicken Sie auf Create repository (Repository erstellen).

Sie haben nun ein Remote-Repository erstellt. In den nächsten Schritten werden Sie dieses Repository in Ihre lokale Umgebung bringen.

Das Repository mit dem git clone Befehl auf die Ubuntu VM klonen

In diesem Schritt klonen Sie das gerade erstellte Repository in Ihre lokale LabEx-Umgebung. Dies ermöglicht es Ihnen, Dateien lokal zu bearbeiten und Workflows zu erstellen.

1. Klicken Sie auf Ihrer GitHub-Repository-Seite auf die grüne Schaltfläche Code.
2. Stellen Sie sicher, dass der Reiter HTTPS ausgewählt ist, und kopieren Sie die URL. Sie sollte etwa so aussehen: https://github.com/your-username/github-actions-demo.git.
3. Öffnen Sie das Terminal in der LabEx-Umgebung. Der Standardpfad ist ~/project.
4. Verwenden Sie den Befehl git clone, um das Repository herunterzuladen. Ersetzen Sie your-username durch Ihren tatsächlichen GitHub-Benutzernamen.

cd ~/project
git clone https://github.com/your-username/github-actions-demo.git

Beispielausgabe:

Cloning into 'github-actions-demo'...
remote: Enumerating objects: 3, done.
remote: Counting objects: 100% (3/3), done.
remote: Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
Receiving objects: 100% (3/3), done.

5. Überprüfen Sie, ob das Verzeichnis erstellt wurde:

ls -F

Sie sollten github-actions-demo/ aufgelistet sehen.

Erstellen eines .github/workflows Verzeichnisses im Repository

GitHub Actions sucht nach Workflow-Konfigurationsdateien in einem bestimmten Verzeichnis innerhalb Ihres Repositorys: .github/workflows. In diesem Schritt erstellen Sie diese Verzeichnisstruktur.

1. Stellen Sie sicher, dass Sie sich im Repository-Verzeichnis befinden:

cd ~/project/github-actions-demo

2. Erstellen Sie das .github-Verzeichnis und das Unterverzeichnis workflows darin mithilfe des mkdir-Befehls mit dem Flag -p (parents):

mkdir -p .github/workflows

3. Git verfolgt leere Verzeichnisse nicht. Um sicherzustellen, dass wir diese Struktur im nächsten Schritt committen können, erstellen wir eine einfache leere Workflow-Datei namens main.yml in diesem Verzeichnis.

touch .github/workflows/main.yml

4. Überprüfen Sie die Struktur:

ls -R .github

Beispielausgabe:

.github:
workflows

.github/workflows:
main.yml

Diese Struktur ist unerlässlich. GitHub erkennt nur YAML-Dateien, die in .github/workflows abgelegt sind, als Action-Workflows.

Änderungen im Verzeichnis mit git add, git commit und git push committen und pushen

In diesem Schritt committen Sie die neue Verzeichnisstruktur und pushen sie auf GitHub.

1. Staging der neuen Dateien für den Commit:

git add .

2. Committen der Änderungen mit einer beschreibenden Nachricht:

git commit -m "Setup GitHub Actions workflow directory"

Beispielausgabe:

[main ... ] Setup GitHub Actions workflow directory
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 .github/workflows/main.yml

3. Pushen der Änderungen auf das Remote-Repository auf GitHub:

git push

Hinweis zur Authentifizierung:
Wenn Sie git push ausführen, werden Sie vom WebIDE automatisch zur Authentifizierung aufgefordert. Befolgen Sie diese detaillierten Schritte:

1. Ein Popup erscheint mit der Meldung: "The extension 'GitHub' wants to sign in using GitHub." Klicken Sie auf Allow.
2. Es erscheint eine neue Benachrichtigung. Klicken Sie auf "Copy&Continue to GitHub" und anschließend im nächsten Dialog auf "Open".
3. Melden Sie sich in dem sich öffnenden Browserfenster bei Ihrem GitHub-Konto an und geben Sie den kopierten Autorisierungscode ein. Nach Bestätigung der Autorisierung schließt sich die Seite automatisch.
4. Warten Sie einige Sekunden, und Sie sehen, wie das Terminal den Push-Vorgang erfolgreich abschließt.

Datenschutzhinweis: Das WebIDE wird zu Authentifizierungszwecken vollen Zugriff auf Ihr GitHub-Konto anfordern. Sie müssen sich keine Sorgen um Datenschutzbedenken machen – die LabEx VM wird sofort nach Abschluss des aktuellen Labs zerstört, und Ihre Anmeldeinformationen sowie Autorisierungsinformationen werden nicht gespeichert.

Dieser Authentifizierungsprozess erfordert keine manuelle Konfiguration von Benutzername oder Personal Access Token (PAT).

Nachdem Sie die Authentifizierungsschritte befolgt haben, sehen Sie eine Ausgabe, die der folgenden ähnelt:

Beispielausgabe:

Enumerating objects: 6, done.
Counting objects: 100% (6/6), done.
Delta compression using up to 4 threads
Compressing objects: 100% (2/2), done.
Writing objects: 100% (5/5), 388 bytes | 388.00 KiB/s, done.
Total 5 (delta 0), reused 0 (delta 0), pack-reused 0
To https://github.com/your-username/github-actions-demo.git
   2e0917f..a191a97  master -> master

4. Besuchen Sie Ihr Repository auf GitHub in einem Webbrowser, um zu bestätigen, dass das Verzeichnis .github/workflows und die Datei main.yml nun in der Repository-Struktur sichtbar sind.

Zusammenfassung

In diesem Lab haben Sie erfolgreich die Grundlage für die Nutzung von GitHub Actions geschaffen. Sie haben:

1. Ein neues Repository auf GitHub erstellt.
2. Das Repository in Ihre lokale Umgebung geklont.
3. Die obligatorische Verzeichnisstruktur .github/workflows erstellt.
4. Diese Änderungen committet und zurück auf GitHub gepusht.

Mit dieser eingerichteten Struktur sind Sie nun bereit, CI/CD-Workflows zu definieren, indem Sie die YAML-Dateien im Verzeichnis workflows bearbeiten.