Zum Hauptinhalt springen
Version: Weekly Build

Gitlab Preview Deployment

Phase 1: Vorbereitung des Accounts​

  1. Lege ein Passwort für dein Codesphere-Account fest (erforderlich für den API-Zugriff).
    • Hinweis: Falls du dich über Google/GitHub angemeldet hast, verwende den Link „Passwort vergessen", um ein eigenständiges Passwort festzulegen.
  2. Verbinde dein GitLab-Account mit Codesphere.
    • Aktion: Klicke auf „+ New Workspace" und wähle „Connect GitLab", um die Autorisierung durchzuführen.
  3. Erstelle einen GitLab Project Access Token.
    • Scopes: Wähle api aus.
    • Rolle: Wähle Developer aus.
    • Kopieren: Speichere diesen Token sofort ab; du benötigst ihn 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 folgende Variablen hinzu (deaktiviere „Protect variable", falls dein Branch nicht geschützt ist):
    • CODESPHERE_EMAIL: Deine Codesphere-Login-E-Mail.
    • CODESPHERE_PASSWORD: Dein Codesphere-Login-Passwort.
    • CI_ACCESS_TOKEN: Der in Phase 1 erstellte Project Access Token.

Phase 3: Pipeline konfigurieren​

  1. Erstelle eine .gitlab-ci.yml-Datei im Root-Verzeichnis deines Repositories.
  2. Füge 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
    ENV: |                # Optional: Add environment variables below
      MY_ENV=test

Phase 4: Deployment & Verifizierung​

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