Bitbucket Preview Deployment

Diese Anleitung erklärt, wie automatisch ein Preview Codesphere Workspace für jeden Pull Request (PR) erstellt wird, der in eurem Bitbucket-Repository geöffnet wird. Dadurch kann euer Team Änderungen in einer Live-Umgebung überprüfen, bevor sie gemerged werden.

Voraussetzungen​

Bevor die Automatisierung eingerichtet wird, stellt sicher, dass Folgendes vorhanden ist:

• Codesphere-Account
• Admin-Zugriff auf das Bitbucket-Repository, das verbunden werden soll

Empfehlung: Service Account verwenden​

Für Produktionsumgebungen empfehlen wir dringend, einen Service Account (einen dedizierten Machine User) anstelle eines persönlichen Entwickler-Accounts zu verwenden. Dies verhindert, dass die Automatisierung unterbrochen wird, wenn ein Teammitglied das Unternehmen verlässt.

1. Service Account erstellen: Registriert euch für einen neuen Codesphere-Account mit einem dedizierten E-Mail-Alias, z. B. [email protected].
2. Zum Team einladen: Meldet euch bei eurem Haupt-Codesphere-Account an und ladet diesen neuen Service Account zu eurem Ziel-Team ein.
3. Bitbucket verbinden: Meldet euch als Service Account an und stellt sicher, dass er die notwendigen Berechtigungen hat, um auf euer Bitbucket-Repository zuzugreifen.
4. Passwort setzen: Da OAuth für die Automatisierung nicht verwendet werden kann, stellt sicher, dass für diesen Service Account ein Passwort gesetzt ist (nutzt den "Forgot Password"-Ablauf, falls ihr euch über Bitbucket/Google registriert habt).

Preview Deployments einrichten​

1. Falls noch nicht erfolgt, erstellt einen Codesphere-User mit Benutzername & Passwort (OAuth funktioniert nicht für die Nutzung von Bitbucket Pipelines) – wir empfehlen, dafür einen separaten Sysadmin-User zu erstellen.
   
2. Meldet euch mit eurem neuen User an und verbindet ihn mit Bitbucket, indem ihr auf den Button "+ Create Workspace" klickt
   
   

und im "Create Workspace"-Modal "Go to Bitbucket Login" auswählt.

Nach der Anmeldung könnt ihr aus euren verfügbaren Repositories auswählen.

3. Stellt sicher, dass der verbundene Bitbucket-Account Zugriff auf das Repository hat, für das ihr die Preview Deployments einrichtet.
4. Stellt sicher, dass das Repository eine Codesphere CI-Pipeline mit Anweisungen enthält, wie eure App gebaut und ausgeführt wird, die eure Pipeline dann nutzen kann, um euer Preview Deployment zu erstellen.
5. Aktiviert Pipelines für euren Bitbucket-Account (erfordert eine aktivierte 2FA).
6. Erstellt einen Bitbucket Access Token mit Lese- und Schreibzugriff auf das Repository und Pull Requests.

7. Navigiert zu Repository Settings > Pipelines > Repository Variables und fügt die folgenden Secrets zu den Umgebungsvariablen des Repositories hinzu – achtet darauf, die Checkbox für "secured" zu aktivieren. Weitere Informationen dazu, welche Variablen gesetzt werden können, findet ihr unten.

8. Erstellt eine Datei bitbucket-pipelines.yml im Root-Verzeichnis eures Repositories und fügt den folgenden Code hinzu:

image: atlassian/default-image:3

pipelines:
  pull-requests:
    '**':
      - step:
          deployment: Test
          script:
            - pipe: docker://ghcr.io/codesphere-cloud/codesphere-monorepo/integrations/bitbucket-ci:latest
              variables:
                API_URL: https://cloud.codesphere.com # replace with your instance URL
                ACCESS_TOKEN: $ACCESS_TOKEN
                EMAIL: $CODESPHERE_EMAIL
                PASSWORD: $CODESPHERE_PASSWORD 
                TEAM: My Team
                PLAN: Micro
                DEPLOYMENT_LINK_TYPE: preview  # or 'dev-domain'
                VPN_CONFIG: vpnConfigName
                ENV: |
                    testing=abc

Ihr könnt eure Pipeline so konfigurieren, dass sie andere Trigger als nur Pull Requests hat. Weitere Informationen zu den verfügbaren Pipeline-Einstellungen von Bitbucket findet ihr hier.

Verfügbare Variablen​

Im Folgenden findet ihr die Variablen, die ihr für eure Repository-Variablen verwenden könnt. (*) = erforderliche Variable.

Zusätzliche Informationen​

Nachdem ihr dieser Anleitung gefolgt seid, wird eure Pipeline bei jedem Pull Request ausgeführt und erstellt ein Preview Deployment, mit dem ihr eure Änderungen überprüfen könnt. Sie fügt eurem Pull Request einen neuen Kommentar hinzu, der die Domain zu eurem Preview Deployment enthält.