Enterprise Server 3.15 ist derzeit als Release Candidate verfügbar.

Migrieren von Bamboo mit dem GitHub Actions Importer

Erfahre, wie du mit dem GitHub Actions Importer die Migration deiner Bamboo-Pipelines zu GitHub Actions automatisierst.

In diesem Artikel

Rechtliche Hinweise

Informationen zum Migrieren von Bamboo mit dem GitHub Actions Importer

In den folgenden Anweisungen erfährst du, wie du deine Umgebung so konfigurierst, dass der GitHub Actions Importer zum Migrieren von Bamboo-Pipelines zu GitHub Actions verwendet wird.

Voraussetzungen

  • Ein Bamboo-Konto oder eine Bamboo-Organisation mit Projekten und Pipelines, die du in GitHub Actions-Workflows konvertieren möchtest

  • Bamboo, Version 7.1.1 oder höher.

  • Zugriffsberechtigungen zum Erstellen eines Bamboo-PAT (personal access token) für dein Konto oder deine Organisation

  • Eine Umgebung, in der du Linux-basierte Container ausführen und die erforderlichen Tools installieren kannst:

    Hinweis: Der GitHub Actions Importer-Container und die CLI müssen nicht auf demselben Server wie deine CI-Plattform installiert werden.

Einschränkungen

Bei der Migration von Bamboo zu GitHub Actions mit dem GitHub Actions Importer gelten einige Einschränkungen:

  • Der GitHub Actions Importer verwendet die YAML-Spezifikation, die vom Bamboo Server generiert wurde, um Migrationen durchzuführen. Wenn Bamboo den Export nach YAML nicht unterstützt, werden die fehlenden Informationen nicht migriert.
  • Triggerbedingungen werden nicht unterstützt. Wenn der GitHub Actions Importer auf einen Trigger mit einer Bedingung stößt, wird die Bedingung als Kommentar angezeigt, und der Trigger wird ohne sie transformiert.
  • Bamboo-Pläne mit angepassten Einstellungen zum Speichern von Artefakten werden nicht transformiert. Stattdessen werden Artefakte mithilfe der Aktionen upload-artifact und download-artifact gespeichert und abgerufen.
  • Deaktivierte Pläne müssen manuell auf der GitHub-Benutzeroberfläche deaktiviert werden. Weitere Informationen findest du unter Deaktivieren und Aktivieren eines Workflows.
  • Deaktivierte Aufträge werden mit einer if: false-Bedingung transformiert, die die Ausführung verhindert. Du musst diese entfernen, um den Auftrag erneut zu aktivieren.
  • Deaktivierte Aufgaben werden nicht transformiert, da sie bei Verwendung der Bamboo-API nicht im exportierten Plan enthalten sind.
  • Bamboo bietet Optionen zum Bereinigen von Buildarbeitsbereichen nach Abschluss eines Builds. Diese werden nicht transformiert, da davon ausgegangen wird, dass von GitHub gehostete Runner oder kurzlebige selbstgehostete Runner dies automatisch verarbeiten.
  • Die Optionen für die Erkennung hängender Builds werden nicht transformiert, da es in GitHub Actions keine Entsprechung gibt. Die Option, die dem am nächsten kommt, ist timeout-minutes für einen Auftrag. Damit lässt festlegen, für wie viele Minuten ein Auftrag ausgeführt werden soll. Weitere Informationen findest du unter Workflowsyntax für GitHub Actions.
  • Mustervergleichsbezeichnungen werden nicht transformiert, da es in GitHub Actions keine Entsprechung gibt.
  • Alle Artefakte werden unabhängig davon, ob sie shared sind oder nicht, in ein actions/upload-artifact transformiert, sodass sie von jedem Auftrag im Workflow heruntergeladen werden können.
  • Berechtigungen werden nicht transformiert, da es in GitHub Actions keine geeignete Entsprechung gibt.
  • Wenn es sich um eine Bambus-Version zwischen 7.1.1 und 8.1.1 handelt, werden Projekt- und Planvariablen nicht migriert.

Manuelle Aufgaben

Bestimmte Bamboo-Konstrukte müssen manuell migriert werden. Dazu zählen unter anderem folgende Einstellungen:

  • Maskierte Variablen
  • Artefaktablaufeinstellungen

Installieren der GitHub Actions Importer-CLI-Erweiterung

  1. So installierst du die GitHub Actions Importer-CLI-Erweiterung:

    Bash
    gh extension install github/gh-actions-importer

  2. Überprüfe, ob die Erweiterung installiert ist:

    $ gh actions-importer -h
Options:
  -?, -h, --help  Show help and usage information

Commands:
  update     Update to the latest version of GitHub Actions Importer.
  version    Display the version of GitHub Actions Importer.
  configure  Start an interactive prompt to configure credentials used to authenticate with your CI server(s).
  audit      Plan your CI/CD migration by analyzing your current CI/CD footprint.
  forecast   Forecast GitHub Actions usage from historical pipeline utilization.
  dry-run    Convert a pipeline to a GitHub Actions workflow and output its yaml file.
  migrate    Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.

Konfigurieren von Anmeldeinformationen

Mit dem CLI-Befehl configure werden die erforderlichen Anmeldeinformationen und Optionen für den GitHub Actions Importer beim Arbeiten mit Bamboo und GitHub festgelegt.

  1. Erstelle ein GitHub-personal access token (classic). Weitere Informationen findest du unter Verwalten deiner persönlichen Zugriffstoken.

    Ihr Token muss als Bereich workflow verwenden.

    Kopiere das Token nach dem Erstellen zur späteren Verwendung an einen sicheren Speicherort.

  2. Erstelle ein Bamboo-PAT (personal access token). Weitere Informationen findest du unter Personal Access Tokens in der Bamboo-Dokumentation.

    Dein Token muss über die folgenden Berechtigungen verfügen, je nachdem, welche Ressourcen transformiert werden.

    RessourcentypSichtKonfiguration anzeigenBearbeiten
    Buildplan
    Bereitstellungsprojekt
    Bereitstellungsumgebung

    Kopiere das Token nach dem Erstellen zur späteren Verwendung an einen sicheren Speicherort.

  3. Führe am Terminal in der GitHub Actions Importer CLI den Befehl configure aus:

    gh actions-importer configure

    Sie werden vom Befehl configure zur Eingabe folgender Informationen aufgefordert:

    • Wähle unter der Frage nach dem CI-Anbieter mithilfe der Pfeiltasten Bamboo aus, drücke die LEERTASTE, um die Option zu markieren, und drücke dann die EINGABETASTE.
    • Geben Sie für „Personal access token für GitHub“ den Wert des personal access token (classic) ein, das Sie zuvor erstellt haben, und drücken Sie die EINGABETASTE.
    • Unter „Basis-URL der GitHub-Instanz“ geben Sie die URL für Ihre GitHub Enterprise Server-Instanz ein, und drücken dann die EINGABETASTE.
    • Gib bei „Personal access token für Bamboo“ den Wert des Bamboo-PAT (personal access token) ein, das du zuvor erstellt hast, und drücke die EINGABETASTE.
    • Gib bei „Basis-URL der Bamboo-Instanz“ die URL für deine Bamboo Server- oder Bamboo Data Center-Instanz ein, und drücke die EINGABETASTE.

    Ein Beispiel für den Befehl configure:

    $ gh actions-importer configure
✔ Which CI providers are you configuring?: Bamboo
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Bamboo: ********************
✔ Base url of the Bamboo instance: https://bamboo.example.com
Environment variables successfully updated.

  4. Führe am Terminal den CLI-Befehl GitHub Actions Importer update aus, um eine Verbindung mit GitHub Packages Container registry herzustellen, und überprüfe, ob das Containerimage auf die neueste Version aktualisiert wurde:

    gh actions-importer update

    Die Ausgabe dieses Befehls sollte in etwa wie folgt aussehen:

    Updating ghcr.io/actions-importer/cli:latest...
ghcr.io/actions-importer/cli:latest up-to-date

Ausführen einer Überprüfung von Bamboo

Mit dem Befehl audit kannst du eine allgemeine Übersicht aller Projekte in einer Bamboo-Organisation abrufen.

Mit dem Befehl audit werden die folgenden Aktionen ausgeführt:

  1. Abrufen aller in einer Bamboo-Organisation definierten Projekte
  2. Konvertieren aller Pipelines in den entsprechenden GitHub Actions-Workflow
  3. Generieren eines Zusammenfassungsberichts darüber, wie vollständig und komplex eine Migration mit GitHub Actions Importer wäre

Ausführen des Überprüfungsbefehls

Zur Überprüfung einer Bamboo-Instanz führst du den folgenden Befehl im Terminal aus:

gh actions-importer audit bamboo --output-dir tmp/audit

Untersuchen der Überprüfungsergebnisse

Die Dateien im angegebenen Ausgabeverzeichnis enthalten die Ergebnisse der Überprüfung. Eine Zusammenfassung der Überprüfungsergebnisse findest du in der Datei audit_summary.md.

Die Überprüfungszusammenfassung enthält die folgenden Abschnitte.

Pipelines

Der Abschnitt „Pipelines“ enthält eine allgemeine Statistik zur Konvertierungsrate durch den GitHub Actions Importer.

Im Folgenden sind einige wichtige Begriffe aufgeführt, die im Abschnitt „Pipelines“ enthalten sein können:

  • Bei erfolgreichen Pipelines wurden 100 % der Pipelinekonstrukte und Einzelelemente automatisch in ihre GitHub Actions-Entsprechung konvertiert.
  • Bei teilweise erfolgreichen Pipelines wurden zwar alle Pipelinekonstrukte, aber nicht alle Einzelelemente automatisch in ihre GitHub Actions-Entsprechung konvertiert.
  • Nicht unterstützte Pipelines sind Definitionstypen, die vom GitHub Actions Importer nicht unterstützt werden.
  • Bei fehlerhaften Pipelines ist beim Konvertieren ein schwerwiegender Fehler aufgetreten. Dies kann aus drei Gründen auftreten:
    • Die Pipeline war ursprünglich falsch konfiguriert und nicht gültig.
    • Der GitHub Actions Importer hat beim Konvertieren ein interner Fehler festgestellt.
    • Es gab eine nicht erfolgreiche Netzwerkantwort, die dazu führte, dass auf die Pipeline nicht zugegriffen werden konnte. Dies ist häufig auf ungültige Anmeldeinformationen zurückzuführen.

Buildschritte

Der Abschnitt „Buildschritte“ enthält eine Übersicht über die einzelnen Buildschritte, die in allen Pipelines verwendet werden, und darüber, wie viele davon vom GitHub Actions Importer automatisch konvertiert wurden.

Im Folgenden sind einige wichtige Begriffe aufgeführt, die im Abschnitt „Buildschritte“ enthalten sein können:

  • Ein bekannter Buildschritt ist ein Schritt, der automatisch in eine entsprechende Aktion konvertiert wurde.
  • Ein unbekannter Buildschritt ist ein Schritt, der nicht automatisch in eine entsprechende Aktion konvertiert wurde.
  • Ein nicht unterstützter Buildschritt ist ein Schritt, für den eine der folgenden Aussagen zutrifft:
    • Er wird grundsätzlich von GitHub Actions nicht unterstützt.
    • Seine Konfiguration ist mit GitHub Actions nicht kompatibel.
  • Eine Aktion ist eine Liste der Aktionen, die in den konvertierten Workflows verwendet wurden. Dies kann für Folgendes wichtig sein:
    • Zum Sammeln der Liste der Aktionen, die mit deiner Instanz synchronisiert werden sollen, sofern du GitHub Enterprise Server verwendest
    • Zum Definieren einer Positivliste der verwendeten Aktionen auf Organisationsebene. Diese Aktionenliste enthält sämtliche Aktionen, die von den Sicherheits- oder Complianceteams möglicherweise überprüft werden müssen.

Manuelle Aufgaben

Der Abschnitt „Manuelle Aufgaben“ enthält eine Übersicht über Aufgaben, die der GitHub Actions Importer nicht automatisch ausführen kann und die du manuell ausführen musst.

Im Folgenden sind einige wichtige Begriffe aufgeführt, die im Abschnitt „Manuelle Aufgaben“ enthalten sein können:

  • Ein Geheimnis gilt auf Repository- oder Organisationsebene und wird in den konvertierten Pipelines verwendet. Diese Geheimnisse müssen manuell in GitHub Actions erstellt werden, damit diese Pipelines ordnungsgemäß funktionieren. Weitere Informationen findest du unter Verwenden von Geheimnissen in GitHub-Aktionen.
  • Selbstgehosteter Runner ist eine Bezeichnung für Runner, auf die in einer konvertierten Pipeline verwiesen wird, und die nicht von GitHub gehostet werden. Du musst diese Runner manuell definieren, damit diese Pipelines ordnungsgemäß funktionieren.

Dateien

Der letzte Abschnitt des Überprüfungsberichts enthält ein Manifest aller Dateien, die während der Überprüfung auf den Datenträger geschrieben wurden.

Für jede Pipelinedatei werden verschiedene Dateien überprüft, z. B.:

  • Die ursprüngliche Pipeline, wie in GitHub definiert
  • Alle Netzwerkantworten, die zum Konvertieren der Pipeline verwendet werden
  • Die konvertierte Workflowdatei
  • Stapelablaufverfolgungen, die zur Problembehandlung bei einer fehlerhaften Pipelinekonvertierung verwendet werden können

Darüber hinaus enthält die Datei workflow_usage.csv eine durch Trennzeichen getrennte Liste aller Aktionen, Geheimnisse und Runner, die von jeder erfolgreich konvertierten Pipeline verwendet werden. Dies kann nützlich sein, um zu bestimmen, welche Workflows Aktionen, Geheimnisse oder Runner verwenden, und um Sicherheitsüberprüfungen durchzuführen.

Vorhersagen der Nutzung

Mit dem Befehl forecast kannst du die potenzielle GitHub Actions-Nutzung vorhersagen, indem du Metriken aus abgeschlossenen Pipelineausführungen in deiner Bamboo-Instanz berechnest.

Ausführen des Vorhersagebefehls

Führe den folgenden Befehl am Terminal aus, um die potenzielle GitHub Actions-Nutzung vorherzusagen. Standardmäßig umfasst der Vorhersagebericht von GitHub Actions Importer die letzten sieben Tage.

gh actions-importer forecast bamboo --output-dir tmp/forecast_reports

Prognose eines Projekts

Um die Prognose auf die mit einem Projekt verknüpften Pläne und Bereitstellungsumgebungen zu beschränken, kannst du die Option --project verwenden, für die der Wert auf einen Buildprojektschlüssel festgelegt ist.

Beispiel:

gh actions-importer forecast bamboo --project PAN --output-dir tmp/forecast_reports

Überprüfen des Prognoseberichts

Die Datei forecast_report.md im angegebenen Ausgabeverzeichnis enthält die Ergebnisse der Vorhersage.

Im Folgenden sind einige wichtige Begriffe aufgeführt, die im Vorhersagebericht enthalten sein können:

  • Die Auftragsanzahl ist die Gesamtanzahl der abgeschlossenen Aufträge.
  • Die Pipelineanzahl ist die Anzahl der verwendeten eindeutigen Pipelines.
  • Die Ausführungszeit ist die Zeit, die ein Runner für einen Auftrag aufgewendet hat. Mithilfe dieser Metrik können die Kosten für von GitHub gehosteten Runnern geplant werden.
    • Diese Metrik korreliert damit, wie viel Sie als Ausgaben in GitHub Actions einplanen sollten. Dies hängt von der Hardware ab, die für diese Ausführungszeit verwendet wurde. Du kannst den Preisrechner für GitHub Actions verwenden, um die Kosten zu schätzen.
  • Metriken zur Warteschlangenzeit beschreiben die Zeit, die ein Auftrag darauf wartet, dass ein Runner für die Ausführung verfügbar ist.
  • Metriken zu gleichzeitigen Aufträgen beschreiben die Anzahl der Aufträge, die zu einem bestimmten Zeitpunkt ausgeführt werden. Diese Metrik kann für Folgendes verwendet werden:

Ausführen einer Probelaufmigration einer Bamboo-Pipeline

Mit dem Befehl dry-run kannst du eine Bamboo-Pipeline in einen entsprechenden GitHub Actions-Workflow konvertieren. Bei einem Probelauf werden nur die Ausgabedateien in einem angegebenen Verzeichnis erstellt, aber kein Pull Request zum Migrieren der Pipeline erstellt.

Ausführen einer Probelaufmigration für einen Buildplan

Um eine Probelaufmigration für deinen Bamboo-Buildplan zu GitHub Actions auszuführen, führe den folgenden Befehl in deinem Terminal aus und ersetze dabei :my_plan_slug durch den Projekt- und Planschlüssel des Plans im Format <projectKey>-<planKey> (Beispiel: PAN-SCRIP).

gh actions-importer dry-run bamboo build --plan-slug :my_plan_slug --output-dir tmp/dry-run

Ausführen einer Probelaufmigration für ein Bereitstellungsprojekt

Um eine Probelaufmigration für dein Bamboo-Bereitstellungsprojekt zu GitHub Actions auszuführen, führe den folgenden Befehl in deinem Terminal aus und ersetze dabei :my_deployment_project_id durch die ID des Bereitstellungsprojekts, das du konvertieren möchtest.

gh actions-importer dry-run bamboo deployment --deployment-project-id :my_deployment_project_id --output-dir tmp/dry-run

Du kannst die Protokolle des Probelaufs und die konvertierten Workflowdateien im angegebenen Ausgabeverzeichnis überprüfen.

Wenn der GitHub Actions Importer etwas nicht automatisch konvertieren konnte (z. B. unbekannte Buildschritte oder eine teilweise erfolgreiche Pipeline), solltest du benutzerdefinierte Transformatoren erstellen, um den Konvertierungsprozess präziser anzupassen. Weitere Informationen findest du unter Erweitern von GitHub Actions Importer mit benutzerdefinierten Transformatoren.

Ausführen einer Produktionsmigration einer Bamboo-Pipeline

Mit dem Befehl migrate kannst du eine Bamboo-Pipeline in einen entsprechenden GitHub Actions-Workflow konvertieren und einen Pull Request erstellen.

Ausführen des Migrationsbefehls für einen Buildplan

Um einen Bamboo-Buildplan zu GitHub Actions zu migrieren, führe den folgenden Befehl in deinem Terminal aus und ersetze dabei den Wert von target-url durch die URL deines GitHub-Repositorys und :my_plan_slug durch den Projekt- und Planschlüssel des Projekts im Format <projectKey>-<planKey>.

gh actions-importer migrate bamboo build --plan-slug :my_plan_slug --target-url :target_url --output-dir tmp/migrate

Die Ausgabe des Befehls enthält die URL zum Pull Request, der den konvertierten Workflow deinem Repository hinzufügt. Beispiel für eine erfolgreiche Ausgabe:

$ gh actions-importer migrate bamboo build --plan-slug :PROJECTKEY-PLANKEY --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'

Ausführen des Migrationsbefehls für ein Bereitstellungsprojekt

Um ein Bamboo-Bereitstellungsprojekt zu GitHub Actions zu migrieren, führe den folgenden Befehl in deinem Terminal aus und ersetze dabei den Wert von target-url durch die URL deines GitHub-Repositorys und :my_deployment_project_id durch die ID des Bereitstellungsprojekts, das du konvertieren möchtest.

gh actions-importer migrate bamboo deployment --deployment-project-id :my_deployment_project_id --target-url :target_url --output-dir tmp/migrate

Die Ausgabe des Befehls enthält die URL zum Pull Request, der den konvertierten Workflow deinem Repository hinzufügt. Beispiel für eine erfolgreiche Ausgabe:

$ gh actions-importer migrate bamboo deployment --deployment-project-id 123 --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate
[2023-04-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20230420-014033.log'
[2023-04-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'

Überprüfen des Pull Requests

Die Ausgabe einer erfolgreichen Ausführung des Befehls migrate enthält einen Link zum neuen Pull Request, mit dem der konvertierte Workflow deinem Repository hinzugefügt wird.

Wichtige Elemente des Pull Requests:

  • In der Beschreibung des Pull Requests findest du den Abschnitt Manuelle Schritte, in dem Schritte aufgeführt sind, die du manuell ausführen musst, um die Migration deiner Pipelines zu GitHub Actions abschließen zu können. In diesem Abschnitt könnte z. B. stehen, dass du Geheimnisse erstellen musst, die im Workflows verwendet werden.
  • Die konvertierte Workflowdatei Wähle im Pull Request die Registerkarte Geänderte Dateien aus, um die Workflowdatei anzuzeigen, die deinem GitHub Enterprise Server-Repository hinzugefügt wird.

Nachdem du den Pull Request überprüft hast, kannst du ihn zusammenführen, um den Workflow deinem GitHub Enterprise Server-Repository hinzuzufügen.

Verweis

Dieser Abschnitt enthält Referenzinformationen zu Umgebungsvariablen, optionalen Argumenten und der unterstützten Syntax, wenn der GitHub Actions Importer für die Migration aus Bamboo verwendet wird.

Verwenden von Umgebungsvariablen

GitHub Actions Importer verwendet Umgebungsvariablen für die Konfiguration der Authentifizierung. Diese Variablen werden beim Ausführen des Konfigurationsvorgangs mithilfe des Befehls configure festgelegt. Weitere Informationen findest du im Abschnitt Konfigurieren von Anmeldeinformationen.

Der GitHub Actions Importer verwendet die folgenden Umgebungsvariablen, um eine Verbindung mit deiner Bamboo-Instanz herzustellen:

  • GITHUB_ACCESS_TOKEN: Das personal access token (classic) zum Erstellen von Pull Requests mit einem konvertierten Workflow (erfordert die Bereiche repo und workflow)
  • GITHUB_INSTANCE_URL: Die URL zur Zielinstanz von GitHub (z. B. https://github.com)
  • BAMBOO_ACCESS_TOKEN: Das Bamboo-PAT (personal access token), das zur Authentifizierung bei deiner Bamboo-Instanz verwendet wird.
  • BAMBOO_INSTANCE_URL: Die URL zur Bamboo-Instanz (Beispiel: https://bamboo.example.com).

Diese Umgebungsvariablen können in einer .env.local-Datei angegeben werden, die zur Ausführungszeit vom GitHub Actions Importer geladen wird.

Optionale Argumente

Es gibt einige optionale Argumente, die du mit den Unterbefehlen von GitHub Actions Importer verwenden kannst, um deine Migration anzupassen.

--source-file-path

Du kannst das Argument --source-file-path mit den Unterbefehlen dry-run oder migrate verwenden.

Standardmäßig ruft der GitHub Actions Importer Pipelineinhalte aus der Bamboo-Instanz ab. Das --source-file-path-Argument weist den GitHub Actions Importer an, stattdessen den angegebenen Quelldateipfad zu verwenden.

Beispiel:

gh actions-importer dry-run bamboo build --plan-slug IN-COM -o tmp/bamboo --source-file-path ./path/to/my/bamboo/file.yml

--config-file-path

Du kannst das --config-file-path-Argument mit den Unterbefehlen audit, dry-run und migrate verwenden.

Standardmäßig ruft der GitHub Actions Importer Pipelineinhalte aus der Bamboo-Instanz ab. Das --config-file-path-Argument weist den GitHub Actions Importer an, stattdessen die angegebenen Quelldateien zu verwenden.

Beispiel für „audit“

In diesem Beispiel verwendet der GitHub Actions Importer die angegebene YAML-Konfigurationsdatei für eine Überprüfung.

gh actions-importer audit bamboo -o tmp/bamboo --config-file-path "./path/to/my/bamboo/config.yml"

Um eine Bamboo-Instanz mithilfe einer Konfigurationsdatei zu überprüfen, muss die Konfigurationsdatei das folgende Format aufweisen, und jeder repository_slug-Wert muss eindeutig sein:

source_files:
  - repository_slug: IN/COM
    path: path/to/one/source/file.yml
  - repository_slug: IN/JOB
    path: path/to/another/source/file.yml
Beispiel für einen Probelauf

In diesem Beispiel verwendet der GitHub Actions Importer die angegebene YAML-Konfigurationsdatei als Quelldatei für einen Probelauf.

Das Platzhalterfeld für das Repository wird mithilfe der Option --plan-slug erstellt. Der Quelldateipfad wird mit der angegebenen Quelldatei abgeglichen und aus dieser gepullt.

gh actions-importer dry-run bamboo build --plan-slug IN-COM -o tmp/bamboo --config-file-path "./path/to/my/bamboo/config.yml"

Unterstützte Syntax für Bamboo-Pipelines

Die folgende Tabelle zeigt den Typ der Eigenschaften, die der GitHub Actions Importer derzeit konvertieren kann.

BambooGitHub-AktionenStatus
environmentsjobsUnterstützt
environments.<environment_id>jobs.<job_id>Unterstützt
<job_id>.artifactsjobs.<job_id>.steps.actions/upload-artifactUnterstützt
<job_id>.artifact-subscriptionsjobs.<job_id>.steps.actions/download-artifactUnterstützt
<job_id>.dockerjobs.<job_id>.containerUnterstützt
<job_id>.final-tasksjobs.<job_id>.steps.ifUnterstützt
<job_id>.requirementsjobs.<job_id>.runs-onUnterstützt
<job_id>.tasksjobs.<job_id>.stepsUnterstützt
<job_id>.variablesjobs.<job_id>.envUnterstützt
stagesjobs.<job_id>.needsUnterstützt
stages.<stage_id>.finaljobs.<job_id>.ifUnterstützt
stages.<stage_id>.jobsjobsUnterstützt
stages.<stage_id>.jobs.<job_id>jobs.<job_id>Unterstützt
stages.<stage_id>.manualjobs.<job_id>.environmentUnterstützt
triggersonUnterstützt
dependenciesjobs.<job_id>.steps.<gh cli step>Teilweise unterstützt
branchesNicht verfügbarNicht unterstützt
deployment.deployment-permissionsNicht verfügbarNicht unterstützt
environment-permissionsNicht verfügbarNicht unterstützt
notificationsNicht verfügbarNicht unterstützt
plan-permissionsNicht verfügbarNicht unterstützt
release-namingNicht verfügbarNicht unterstützt
repositoriesNicht verfügbarNicht unterstützt

Weitere Informationen zu unterstützten Bamboo-Konzepten und Plug-In-Zuordnungen findest du im github/gh-actions-importer-Repository.

Zuordnung von Umgebungsvariablen

Der GitHub Actions Importer verwendet die Zuordnungen in der folgenden Tabelle, um die Standardumgebungsvariablen von Bamboo in das am besten passende Pendant in GitHub Actions zu konvertieren.

BambooGitHub-Aktionen
bamboo.agentId${{ github.runner_name }}
bamboo.agentWorkingDirectory${{ github.workspace }}
bamboo.buildKey${{ github.workflow }}-${{ github.job }}
bamboo.buildNumber${{ github.run_id }}
bamboo.buildPlanName${{ github.repository }}-${{ github.workflow }}-${{ github.job }
bamboo.buildResultKey${{ github.workflow }}-${{ github.job }}-${{ github.run_id }}
bamboo.buildResultsUrl${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
bamboo.build.working.directory${{ github.workspace }}
bamboo.deploy.project${{ github.repository }}
bamboo.ManualBuildTriggerReason.userName${{ github.actor }}
bamboo.planKey${{ github.workflow }}
bamboo.planName${{ github.repository }}-${{ github.workflow }}
bamboo.planRepository.branchDisplayName${{ github.ref }}
bamboo.planRepository.<position>.branch${{ github.ref }}
bamboo.planRepository.<position>.branchName${{ github.ref }}
bamboo.planRepository.<position>.name${{ github.repository }}
bamboo.planRepository.<position>.repositoryUrl${{ github.server }}/${{ github.repository }}
bamboo.planRepository.<position>.revision${{ github.sha }}
bamboo.planRepository.<position>.username${{ github.actor}}
bamboo.repository.branch.name${{ github.ref }}
bamboo.repository.git.branch${{ github.ref }}
bamboo.repository.git.repositoryUrl${{ github.server }}/${{ github.repository }}
bamboo.repository.pr.key${{ github.event.pull_request.number }}
bamboo.repository.pr.sourceBranch${{ github.event.pull_request.head.ref }}
bamboo.repository.pr.targetBranch${{ github.event.pull_request.base.ref }}
bamboo.resultsUrl${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
bamboo.shortJobKey${{ github.job }}
bamboo.shortJobName${{ github.job }}
bamboo.shortPlanKey${{ github.workflow }}
bamboo.shortPlanName${{ github.workflow }}

Note

Unbekannte Variablen werden in ${{ env.<variableName> }} transformiert und müssen ersetzt oder unter env hinzugefügt werden, damit der Vorgang ordnungsgemäß funktioniert. Beispielsweise wird ${bamboo.jira.baseUrl} zu ${{ env.jira_baseUrl }}.

Systemvariablen

Systemvariablen, die in Aufgaben verwendet werden, werden in die entsprechende Bash-Shell-Variable transformiert und als verfügbar angenommen. Beispielsweise wird ${system.<variable.name>} in $variable_name transformiert. Es empfiehlt sich, dies zu überprüfen, um den ordnungsgemäßen Betrieb des Workflows sicherzustellen.

Teile wurden von https://github.com/github/gh-actions-importer/ unter der MIT-Lizenz übernommen:

MIT License

Copyright (c) 2022 GitHub

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.