Zum Inhalt

DATAMIMIC-Projekt mit einem Git-Branch synchronisieren

Diese Anleitung erklärt, wie Du Dein DATAMIMIC-Projekt mit einem bestimmten Git-Branch per API-Aufruf synchronisierst. Mit dieser Funktion kannst Du Dein Projekt mit Deinem Git-Repository abgleichen, die neuesten Änderungen aus jedem Branch übernehmen und den Inhalt Deines DATAMIMIC-Projekts überschreiben.

Warning

Dieser Vorgang überschreibt alle lokalen Änderungen in Deinem DATAMIMIC-Projekt mit dem Inhalt des angegebenen Git-Branches. Stelle sicher, dass Du alle wichtigen Arbeiten vorher sicherst.

Note

Die Synchronisation mit einem Git-Branch ist derzeit nur über die API möglich und kann nicht über die DATAMIMIC-Oberfläche durchgeführt werden.

Voraussetzungen

  • Ein DATAMIMIC-Projekt, das als Git-Projekt korrekt konfiguriert ist
  • Ein Projekt-Zugriffstoken für die API-Authentifizierung
  • Ein HTTP-Client-Tool auf Deinem System installiert. In dieser Anleitung verwenden wir curl.
  • Zugriff auf das Git-Repository und den gewünschten Branch

Schritt-für-Schritt-Anleitung

Schritt 1: Erstelle ein DATAMIMIC-Git-Projekt

Falls Du noch kein Git-verbundenes DATAMIMIC-Projekt erstellt hast, folge diesen Schritten:

  1. Navigiere zur Projektansicht
  2. Klicke auf die (+)-Schaltfläche, um ein neues Projekt zu erstellen
  3. Wähle Git-Projekt aus den Projektassistent-Optionen
  4. Wähle Deinen Git-Anbieter und gib die URL sowie Authentifizierungsdaten Deines Git-Repositories an
  5. Schließe die Projekterstellung ab

Detaillierte Anweisungen findest Du in der Dokumentation zur Git-Projekterstellung.

Schritt 2: Erzeuge ein Projekt-Zugriffstoken

Um per API mit Deinem Projekt zu interagieren, benötigst Du ein Projekt-Zugriffstoken:

  1. Navigiere zu Deinem Projekt
  2. Gehe zu Einstellungen → Tokens
  3. Füge ein neues Projekt-Zugriffstoken hinzu
  4. Kopiere und speichere sowohl die Projekt-ID als auch das Projekt-Zugriffstoken sicher ab

Wenn Du mit Projekt-Zugriffstoken nicht vertraut bist, empfehlen wir Dir die Dokumentation zu Projekt-Zugriffstoken zu lesen.

Schritt 3: Mit Git-Branch synchronisieren

Nutze den folgenden API-Endpunkt, um Dein DATAMIMIC-Projekt mit einem bestimmten Git-Branch zu synchronisieren:

1
2
3
4
curl -X 'PUT' \
  'https://your-datamimic-instance/api/v1/{project-id}/git?branch_name={branch-name}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {your-project-access-token}'

Parameter

  • {project-id}: Die Kennung Deines DATAMIMIC-Projekts
  • {branch-name}: Der Name des Git-Branches, mit dem Du synchronisieren möchtest (z.B. development, main, feature/neues-feature)
  • {your-project-access-token}: Dein Projekt-Zugriffstoken

Beispiel

1
2
3
4
curl -X 'PUT' \
  'https://datamimic.example.com/api/v1/abc123-def456-ghi789/git?branch_name=development' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer dm_pat_1234567890abcdef'

Schritt 4: Erfolg überprüfen

Nach erfolgreicher Ausführung gibt die API zurück:

  • HTTP-Statuscode: 201 Created
  • Antwort: Eine Erfolgsmeldung, die den Vorgang bestätigt

Der Server wird:

  1. Dein Git-Repository klonen
  2. Den angegebenen Branch auschecken
  3. Alle Dateien in Deinem DATAMIMIC-Projekt mit dem Inhalt des Git-Branches ersetzen
  4. Einen Snapshot des aktualisierten Projekts erstellen

API-Antwortbeispiele

Erfolgreiche Antwort

1
2
3
4
5
6
HTTP/1.1 201 Created
Content-Type: application/json

{
  "message": "Projekt erfolgreich mit Git-Branch 'development' synchronisiert"
}

Fehlerantworten

Authentifizierung fehlgeschlagen

1
2
3
4
5
6
HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "detail": "Authentifizierung fehlgeschlagen"
}

Projekt nicht gefunden oder kein Git-Projekt

1
2
3
4
5
6
HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "detail": "Projekt nicht gefunden oder Git-Repository nicht konfiguriert"
}

Ungültiger Branch-Name

1
2
3
4
5
6
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "detail": "Ungültiger Branch-Name oder Branch existiert nicht"
}

Erweiterte Nutzung

Einrichtung von Umgebungsvariablen

Für eine einfachere Verwaltung kannst Du Umgebungsvariablen einrichten:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Setze Deine Variablen
export PROJECT_ID="dein-projekt-id"
export ACCESS_TOKEN="dein-projekt-zugriffstoken"
export API_BASE="https://your-datamimic-instance/api/v1"
export BRANCH_NAME="development"

# Mit Git-Branch synchronisieren
curl -X 'PUT' \
  "${API_BASE}/${PROJECT_ID}/git?branch_name=${BRANCH_NAME}" \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${ACCESS_TOKEN}"

Best Practices

  1. Wichtige Arbeiten sichern: Stelle immer sicher, dass Deine lokalen Änderungen in Git committet oder gesichert sind, bevor Du synchronisierst
  2. Mit Nicht-Produktiv-Branches testen: Teste den Synchronisationsprozess zunächst mit Entwicklungs- oder Feature-Branches, bevor Du ihn auf Produktiv-Branches anwendest
  3. Branch-Existenz prüfen: Stelle sicher, dass der Ziel-Branch im Git-Repository existiert, bevor Du synchronisierst
  4. Aussagekräftige Branch-Namen verwenden: Nutze klare, beschreibende Branch-Namen, die den Namenskonventionen Deines Teams entsprechen
  5. API-Antworten überwachen: Überprüfe immer den HTTP-Statuscode und die Antwortnachricht, um erfolgreiche Vorgänge sicherzustellen

Fehlerbehebung

Häufige Probleme

  1. 401 Unauthorized: Überprüfe, ob Dein Projekt-Zugriffstoken gültig ist und die erforderlichen Berechtigungen besitzt
  2. 404 Not Found: Vergewissere Dich, dass die Projekt-ID korrekt ist und das Projekt als Git-Projekt konfiguriert ist
  3. 422 Unprocessable Entity: Stelle sicher, dass der Branch-Name gültig ist und im Git-Repository existiert
  4. 500 Internal Server Error: Überprüfe Deine Git-Repository-Zugangsdaten und die Netzwerkverbindung

Hilfe erhalten