Migration von Bamboo mit dem GitHub Actions Importer

Erfahren Sie, wie Sie GitHub Actions Importer verwenden, um die Migration Ihrer Bamboo-Pipelines zu GitHub Actions zu automatisieren.

In diesem Artikel

Informationen zur Migration von Bamboo mit dem GitHub Actions Importer

Die folgenden Anweisungen helfen Ihnen dabei, Ihre Umgebung so zu konfigurieren, dass Sie GitHub Actions Importer verwenden können, um Bamboo-Pipelines zu GitHub Actions zu migrieren.

Voraussetzungen

  • Ein Bamboo-Konto oder eine Organisation mit Projekten und Pipelines, die Sie in GitHub Actions Workflows umwandeln möchten.
  • Bamboo, Version 7.1.1 oder höher.
  • Zugriff zum Erstellen eines Bamboo personal access token für Ihr Konto oder Ihre 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

Es gibt einige Einschränkungen bei der Migration von Bamboo zu GitHub Actions mit GitHub Actions Importer:

  • GitHub Actions Importer basiert auf der YAML-Spezifikation, die vom Bamboo Server generiert wird, 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 GitHub Actions Importer auf einen Trigger mit einer Bedingung trifft, wird die Bedingung als Kommentar angezeigt und der Trigger ohne diese Bedingung umgewandelt.
  • 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 in der GitHub-Benutzeroberfläche deaktiviert werden. Weitere Informationen finden Sie 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 zur Erkennung hängender Builds werden nicht übernommen, 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 finden Sie unter Workflowsyntax für GitHub Actions.
  • Bezeichnungen für den Musterabgleich werden nicht umgewandelt, da es in GitHub Actions keine Entsprechung gibt.
  • Alle Artefakte werden unabhängig davon, ob sie actions/upload-artifact sind oder nicht, in ein shared transformiert, sodass sie von jedem Auftrag im Workflow heruntergeladen werden können.
  • Berechtigungen werden nicht umgewandelt, da es in GitHub Actions kein geeignetes Äquivalent 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:

  • 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

Der configure CLI-Befehl wird verwendet, um erforderliche Anmeldeinformationen und Optionen für GitHub Actions Importer bei der Arbeit mit Bamboo und GitHub festzulegen.

  1. Erstellen Sie eine GitHubpersonal access token (classic). Weitere Informationen finden Sie unter Verwalten deiner persönlichen Zugriffstoken.

    Ihr Token muss den workflow Bereich haben.

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

  2. Erstellen Sie einen Bambus personal access token. Weitere Informationen finden Sie Personal Access Tokens in der Bambusdokumentation.

    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ühren Sie in Ihrem Terminal den CLI-Befehl GitHub Actions Importerconfigure aus.

    gh actions-importer configure

    Sie werden vom Befehl configure zur Eingabe folgender Informationen aufgefordert:

    • Für "Welche CI-Anbieter konfigurieren Sie?", verwenden Sie die Pfeiltasten, um Bamboo zu wählen, drücken Sie die Leertaste, um es auszuwählen, und drücken Sie dann Enter.
    • Geben Sie für "Personal access token für GitHub" den zuvor erstellten Wert von personal access token (classic) ein und drücken Sie die EINGABETASTE.
    • Geben Sie für "Basis-URL der GitHub-Instanz" die URL deine GitHub Enterprise Server-Instanz ein, und drücken Sie die EINGABETASTE.
    • Geben Sie für "Personal access token für Bamboo" den Wert für die Bamboo-personal access token ein, die Sie zuvor erstellt haben, und drücken Sie 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ühren Sie in Ihrem Terminal den GitHub Actions Importerupdate CLI-Befehl aus, um eine Verbindung herzustellen GitHub PackagesContainer registry und sicherzustellen, dass das Containerimage auf die neueste Version aktualisiert wird:

    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

Ein Audit von Bamboo durchführen

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. Alle in einer Bamboo-Organisation definierten Projekte werden abgerufen.
  2. Konvertiert jede Pipeline in den entsprechenden GitHub Actions Workflow.
  3. Generiert einen Bericht, der zusammenfasst, inwieweit eine Migration mit GitHub Actions Importer vollständig und komplex möglich ist.

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 allgemeine Statistiken zur von GitHub Actions Importer erzielten Conversion-Rate.

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

  • Erfolgreiche Pipelines hatten 100 % ihrer Pipeline-Komponenten und einzelnen Elemente automatisch in das entsprechende GitHub Actions-Äquivalent konvertiert.
  • Teilweise erfolgreich waren Pipelines, bei denen alle Pipeline-Konstrukte konvertiert wurden; einige einzelne Elemente wurden jedoch nicht automatisch in ihr entsprechendes GitHub Actions-Äquivalent konvertiert.
  • Nicht unterstützte Pipelines sind Definitionstypen, die von 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.
    • GitHub Actions Importer Beim Konvertieren ist ein interner Fehler aufgetreten.
    • 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“ bietet einen Überblick über einzelne Buildschritte, die in allen Pipelines verwendet werden, und darüber, wie viele von GitHub Actions Importer automatisch konvertiert wurden.

Im Folgenden sind einige wichtige Begriffe aufgeführt, die im Abschnitt „Build-Schritte“ vorkommen können:

  • Ein bekannter Build-Schritt ist ein Schritt, der automatisch in eine äquivalente Aktion umgewandelt wurde.
  • Ein unbekannter Buildschritt ist ein Schritt, der nicht automatisch in eine entsprechende Aktion konvertiert wurde.
  • Ein nicht unterstützter Buildschritt ist ein Schritt, der entweder:
    • Grundsätzlich nicht unterstützt von GitHub Actions.
    • So konfiguriert, dass sie mit GitHub Actions nicht kompatibel ist.
  • Eine Aktion ist eine Liste der Aktionen, die in den konvertierten Workflows verwendet wurden. Dies kann für Folgendes wichtig sein:
    • Wenn Sie GitHub Enterprise Server verwenden, wird die Liste der Aktionen zusammengestellt, die mit Ihrer Instanz synchronisiert werden sollen.
    • Definieren einer Zulassungsliste 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 Vorgänge, die GitHub Actions Importer nicht automatisch abgeschlossen werden können und dass Sie manuell ausführen müssen.

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 Secrets müssen in GitHub Actions manuell erstellt werden, damit diese Pipelines korrekt funktionieren. Weitere Informationen finden Sie unter Verwenden von Geheimnissen in GitHub-Aktionen.
  • Ein selbstgehosteter Runner bezeichnet ein Label eines Runners, auf den in einer konvertierten Pipeline verwiesen wird und der kein GitHub-hosteter Runner ist. 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.

Jede Pipeline-Datei enthält verschiedene Dateien, die in das Audit einbezogen werden, darunter:

  • Die ursprüngliche Pipeline, wie sie in GitHub definiert wurde.
  • Alle Netzwerkantworten, die für die Umwandlung 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

Sie können den Befehl forecast verwenden, um die potenzielle GitHub Actions-Nutzung vorherzusagen, indem Sie anhand abgeschlossener Pipeline-Ausführungen in Ihrer Bamboo-Instanz Metriken berechnen.

Ausführen des Vorhersagebefehls

Um eine Prognose der potenziellen GitHub Actions Nutzung durchzuführen, führen Sie den folgenden Befehl in Ihrem Terminal aus. Standardmäßig enthält GitHub Actions Importer die vorherigen sieben Tage im Prognosebericht.

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. Diese Metrik kann verwendet werden, um die Kosten für GitHub-gehostete Runner zu planen.
    • Diese Metrik steht im Zusammenhang mit den Ausgaben, die Sie in GitHub Actions erwarten sollten. Dies wird je nach der für diese Minuten verwendeten Hardware variieren. Sie können den GitHub Actions Preisrechner verwenden, um die Kosten zu schätzen.
  • Metriken zur Warteschlangenzeit beschreiben die Zeit, die ein Auftrag in der Warteschlange verbringt, bis ein Runner zur 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

Sie können den dry-run Befehl verwenden, um eine Bambuspipeline in einen entsprechenden GitHub Actions Workflow zu konvertieren. Bei einem Probelauf werden die Ausgabedateien in einem angegebenen Verzeichnis erstellt, jedoch wird kein Pull-Request zur Migration der Pipeline eröffnet.

Ausführen einer Probelaufmigration für einen Buildplan

Um einen Testlauf für die Migration Ihres Bamboo-Build-Plans zu GitHub Actions durchzuführen, führen Sie den folgenden Befehl in Ihrem Terminal aus und ersetzen Sie :my_plan_slug durch den Projektschlüssel und den Planschlüssel im Format <projectKey>-<planKey> (zum 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 einen Testlauf für die Migration Ihres Bamboo-Bereitstellungsprojekts nach GitHub Actions durchzuführen, führen Sie den folgenden Befehl in Ihrem Terminal aus und ersetzen Sie dabei :my_deployment_project_id durch die ID des Bereitstellungsprojekts, das Sie konvertieren.

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

Sie können 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 finden Sie unter Das Erweitern des GitHub Actions Importers mit benutzerdefinierten Transformatoren.

Ausführen einer Produktionsmigration einer Bamboo-Pipeline

Sie können den migrate Befehl verwenden, um eine Bambuspipeline zu konvertieren und eine Pullanforderung mit dem entsprechenden GitHub Actions Workflow zu öffnen.

Ausführen des Migrationsbefehls für einen Buildplan

Um einen Bamboo-Build-Plan zu GitHub Actions migrieren, führen Sie den folgenden Befehl in Ihrem Terminal aus und ersetzen Sie den Wert target-url durch die URL Ihres GitHub-Repositorys und :my_plan_slug durch den Projekt- und Plan-Schlüssel des Plans 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ühren Sie den folgenden Befehl in Ihrem Terminal aus, wobei Sie den Wert target-url durch die URL Ihres GitHub-Repositorys und :my_deployment_project_id durch die ID des Bereitstellungsprojekts ersetzen, das Sie umwandeln.

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 Files changed aus, um die Workflowdatei anzuzeigen, die deinem GitHub-Repository hinzugefügt wird.

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

Verweis

Dieser Abschnitt enthält Referenzinformationen zu Umgebungsvariablen, optionalen Argumenten und zur unterstützten Syntax bei der Verwendung von GitHub Actions Importer für die Migration von Bamboo.

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.

GitHub Actions Importer verwendet die folgenden Umgebungsvariablen, um eine Verbindung mit Ihrer Bambus-Instanz herzustellen:

  • GITHUB_ACCESS_TOKEN: Die personal access token (classic) wird verwendet, um Pullanforderungen mit einem konvertierten Workflow zu erstellen (erfordert die Berechtigungen repo und workflow).
  • GITHUB_INSTANCE_URL: Die URL zur Zielinstanz GitHub (z. B https://github.com. ).
  • BAMBOO_ACCESS_TOKEN: Das Bamboo-personal access token, das zur Authentifizierung bei Ihrer 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 geladen wird, wenn GitHub Actions Importer ausgeführt 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.

GitHub Actions Importer ruft standardmäßig Pipelineinhalte aus der Bamboo-Instanz ab. Das --source-file-path Argument weist GitHub Actions Importer stattdessen an, 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 GitHub Actions Importer die Pipeline-Inhalte aus der Bamboo-Instanz ab. Das --config-file-path Argument weist GitHub Actions Importer stattdessen an, die angegebenen Quelldateien zu verwenden.

Beispiel für Prüfung

In diesem Beispiel GitHub Actions Importer wird die angegebene YAML-Konfigurationsdatei verwendet, um ein Audit durchzuführen.

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 wird GitHub Actions Importer die angegebene YAML-Konfigurationsdatei als Quelldatei verwendet, um einen Testlauf durchzuführen.

Der Repository-Slug wird mithilfe der Option --plan-slug erstellt. Der Quelldateipfad wird mit der angegebenen Quelldatei abgestimmt und daraus abgerufen.

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 die Art von Eigenschaften, die 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 zutreffendNicht unterstützt
deployment.deployment-permissionsNicht zutreffendNicht unterstützt
environment-permissionsNicht zutreffendNicht unterstützt
notificationsNicht zutreffendNicht unterstützt
plan-permissionsNicht zutreffendNicht unterstützt
release-namingNicht zutreffendNicht unterstützt
repositoriesNicht zutreffendNicht unterstützt

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

Zuordnung von Umgebungsvariablen

GitHub Actions Importer verwendet die Zuordnung in der nachstehenden Tabelle, um standardmäßige Bamboo-Umgebungsvariablen in die nächstliegende Entsprechung in GitHub Actions umzuwandeln.

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 }}

Hinweis

Unbekannte Variablen werden zu ${{ env.<variableName> }} umgewandelt und müssen für den ordnungsgemäßen Betrieb unter env ersetzt oder hinzugefügt werden. Beispiel: ${bamboo.jira.baseUrl} wird .${{ 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.