Zum Hauptinhalt springen
Version: Weekly Build

Gitlab Preview Deployment

Phase 1: Vorbereitung des Accounts​

  1. Lege ein Passwort für dein Codesphere-Konto fest (erforderlich für den API-Zugriff).
    • Hinweis: Falls du dich über Google/GitHub angemeldet hast, nutze den Link „Passwort vergessen“, um ein eigenständiges Passwort festzulegen.
  2. Verbinde dein GitLab-Konto mit Codesphere.
    • Aktion: Klicke auf „+ New Workspace“ und wähle „Connect GitLab“, um die Autorisierung durchzuführen.
  3. Erstelle ein GitLab Project Access Token.
    • Scopes: Wähle api.
    • Rolle: Wähle Developer.
    • Kopieren: Speichere dieses Token sofort; du benötigst es für die Secrets.

Phase 2: Konfiguration der GitLab Secrets​

  1. Öffne dein Repository in GitLab.
  2. Navigiere zu Settings > CI/CD > Variables.
  3. Füge die folgenden Variablen hinzu (deaktiviere „Protect variable“, falls dein Branch nicht geschützt ist):
    • CODESPHERE_EMAIL: Deine Codesphere-Login-E-Mail-Adresse.
    • CODESPHERE_PASSWORD: Dein Codesphere-Login-Passwort.
    • CI_ACCESS_TOKEN: Das in Phase 1 erstellte Project Access Token.

Phase 3: Konfiguration der Pipeline​

  1. Erstelle eine Datei .gitlab-ci.yml im Root-Verzeichnis deines Repositorys.
  2. Füge die folgende Konfiguration ein:
workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'

stages:
  - deploy

codesphere-deploy:
  image: ghcr.io/codesphere-cloud/codesphere-monorepo/integrations/gitlab-ci:latest
  stage: deploy
  script:
    - node /app/server.js
  variables:
    API_URL: https://cloud.codesphere.com/ # replace with your instance URL
    ACCESS_TOKEN: $CI_ACCESS_TOKEN
    EMAIL: $CODESPHERE_EMAIL
    PASSWORD: $CODESPHERE_PASSWORD
    TEAM: 'My Team'       # REPLACE with your exact Team Name
    PLAN: 'Boost'         # Options: Micro, Boost, Pro
    ON_DEMAND: 'true'     # 'true' enables cost-saving standby mode
    SHARED_VAULT_NAME: 'my-shared-vault'  # Optional: reuse a team shared vault's secrets across preview deployments
    ENV: |                # Optional: Add environment variables below
      MY_ENV=test

Shared Vaults

SHARED_VAULT_NAME verbindet einen bestehenden Team Shared Vault mit dem Preview Deployment, sodass dessen Secrets wiederverwendet werden, anstatt einen eigenen, isolierten Satz zu pflegen. Der Shared Vault muss bereits im Team konfiguriert sein. Siehe Secret Management → Shared Vaults.

Phase 4: Deployment & Überprüfung​

  1. Committe und pushe die Datei .gitlab-ci.yml.
  2. Öffne einen neuen Merge Request in deinem Repository.
  3. Prüfe den Kommentarbereich deines Merge Requests.
    • Erfolg: Codesphere postet automatisch einen Kommentar mit dem direkten Link zu deinem neuen Preview Deployment.