Mit GitLab Pages können Sie statische Websites hosten und damit beispielsweise eine Projektdokumentation erstellen. Sie können eine Website auf zwei Wegen erstellen:

• Eine Pages-Vorlage forken
• Ein neues Projekt erstellen

Eine Pages-Vorlage forken

Wenn Sie auf eine Vorlage zurückgreifen möchten, finden Sie einige Beispiele, die Sie forken und mit Inhalt füllen können.

Jekyll-Templates: Bitte beachten Sie, dass Sie die _config.yml-Datei bearbeiten müssen:

• url: “https://pages.cms.hu-berlin.de”
• baseurl: “/namespace/projektname”

Zudem müssen Sie einen Runner einrichten.

Ein Pages-Projekt selbst erstellen

Um ein Pages-Projekt selbst zu erstellen, sind folgende Schritte notwendig:

1. Ein neues GitLab-Projekt anlegen
2. Konfigurationsdatei ins Root-Verzeichnis hinzufügen (.gitlab-ci.yml)
3. Inhalt der Website hinzufügen
4. Benutzerdefinierte Domain hinzufügen (optional)
5. Runner einrichten

Konfigurationsdatei erstellen

Bevor die Website erscheint, muss die CI konfiguriert werden. Im Root-Verzeichnis des Projekts wird dazu eine Konfigurationsdatei .gitlab-ci.yml angelegt. In dieser sind die Build-Anweisungen enthalten. Für eine statische HTML-Website sollte die Datei wie folgt aussehen:

pages:  
    stage: deploy
    script:
    - mkdir .public  
    - cp -r * .public
    - mv .public public
    artifacts:
        paths:  
        - public
    only:
    - master

Diese Anweisungen erzeugt einen Job mit dem Namen Pages. Zunächst werden ein public-Ordner erzeugt und die Dateien aus dem Root-Verzeichnis in diesen Ordner verschoben (dies können Sie jedoch auch manuell durchführen). Dann wird dem Runner die Anweisung gegeben, einen Deploy der Website auf einem öffentlichen Pfad durchzuführen, sobald ein Commit in den Master stattfindet.
Wenn Sie auf die zuvor angegebenen Vorlagen zurückgreifen, ist bereits eine Konfigurationsdatei enthalten. Eine Sammlung von Yml-Dateien finden Sie zusätzlich auf der GitLab-Yml-Projektwebsite.

Achtung: Bei der Formatierung der yml-Datei müssen Sie aufpassen. Die Einrückung erfolgt niemals mit Tabs. Bei Formatierungsfehlern kann der angelegte Job nicht ausgeführt werden. In diesem Fall erhalten Sie eine Benachrichtigung per E-Mail. Zudem können Sie im linken Seitenmenü auf CI/CD und dann auf Pipelines klicken. Wenn ein Formatierungsfehler vorliegt, erhält Ihr Job das Label yaml invalid.

Runner einrichten

Damit der Job, der in der .gitlab-ci.yml-Datei festgelegt wurde, ausgeführt wird, ist die Angabe eines Runners notwendig. Sie können dazu den Shared Runner verwenden, der allen Nutzern des HU-GitLab zur Verfügung steht. Um den Runner für Ihr Projekt einzurichten, klicken Sie in der Übersicht des Projekts im linken Seitenmenü auf Settings und dann auf CI/CD. Navigieren Sie dann zum Abschnitt Runners Settings. Klicken Sie unter Shared Runners auf Enable shared Runners. Nun wird der Job durch den Runner ausgeführt.

Pfad zu Ihrer Pages-Website

Sie finden Ihre Pages-Website unter folgendem Pfad:
https://pages.cms.hu-berlin.de/namespace/projektname/

Für namespace fügen Sie den Namespace Ihrer Gruppe oder Ihres Benutzernamens ein, für projektname den Namen des Projekts.