Bereitstellung

Wichtiger Hinweis

Zielgruppe
Diese Seite wendet sich ausschließlich an technisch verantwortliche Personen.

Hier erläutern wir, wie die Bereitstellung für Dokumentationswebsites (Deployment) funktioniert.

Die Bereitstellung wird über GitLab-Webhooks ausgelöst, sobald einer der folgenden CI-Abschnitte erreicht wird:

• upload:preview -> Deployment nach preview.docs.fitko.dev/<PROJECT_SLUG>/<MERGE_REQUEST_ID>/
• stop:preview -> Das Preview-Deployment wird wieder entfernt
• upload:production -> Deployment nach docs.fitko.de/<PROJECT_SLUG>/

Wenn Sie eine neue Docusaurus-Instanz für die Bereitstellung vorbereiten, muss Ihr GitLab-Repository korrekt konfiguriert und Ihr Projekt am Bereitstellungs-Webserver registriert sein. Bitte kontaktieren Sie die FITKO, um neue Projekte zu registrieren.

GitLab-Projekt konfigurieren

1. Verwenden Sie die .gitlab-ci.yml aus dem Template-Repository (öffnet in neuem Tab) als CI-Vorlage.

2. Die Bereitstellung erwartet einen build/-Ordner im Artefakt des build-Jobs. Ändern Sie die .gitlab-ci.yml-Vorlage also an der Stelle nicht.

3. Richten Sie einen Webhook in Ihrem Projekt oder Ihrer Gruppe ein:

   1. Navigieren Sie zu Settings -> Webhooks
   2. Verwenden Sie https://docs.fitko.de/hooks/deploy als Webhook-URL
   3. Fordern Sie ein Webhook-Secret an und hinterlegen Sie es als Secret Token
   4. Aktivieren Sie Job events als Auslöser
   5. Klicken Sie auf Add webhook

Repository auf docs.fitko.de registrieren (Webserver)

Die Registrierung Ihres Projekts erfolgt grundsätzlich durch das FEP-Kernteam.
Für die Registrierung benötigen wir:

1. Die GitLab-Projekt-ID (unter Settings -> General einsehbar)
2. Ihren gewünschten <PROJECT_SLUG>, also die Zeichenfolge hinter docs.fitko.de, unter der Ihre Dokumentationswebsite erreichbar sein soll.

Hinter den Kulissen

Für das Ausführen der Webhooks setzen wir adnanh/webhook (öffnet in neuem Tab) ein.