Diese Version von GitHub Enterprise Server wurde eingestellt am 2024-03-26. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise Server. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.

Migrieren von CircleCI mit dem GitHub Actions Importer

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

In diesem Artikel

Rechtliche Hinweise

Informationen zum Migrieren von CircleCI 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 CircleCI-Pipelines zu GitHub Actions verwendet wird.

Voraussetzungen

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

  • Zugriffsberechtigungen für das Erstellen eines persönlichen CircleCI-API-Tokens 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 CircleCI zu GitHub Actions mit dem GitHub Actions Importer gelten einige Einschränkungen:

  • Die automatische Zwischenspeicherung zwischen Aufträgen verschiedener Workflows wird nicht unterstützt.
  • Der Befehl audit wird nur unterstützt, wenn ein Organisationskonto verwendet wird. Die Befehle dry-run und migrate können jedoch mit einem Organisations- oder Benutzerkonto verwendet werden.

Manuelle Aufgaben

Bestimmte CircleCI-Konstrukte müssen manuell migriert werden. Dazu gehören:

  • Kontexte
  • Umgebungsvariablen auf Projektebene
  • Unbekannte Auftragseigenschaften
  • Unbekannte Orbs

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 GitHub Actions Importer beim Arbeiten mit CircleCI und GitHub festgelegt.

  1. Erstelle ein GitHub-personal access token. 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 persönliches CircleCI-API-Token. Weitere Informationen findest du unter Verwalten von API-Token in der CircleCI-Dokumentation.

    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 CircleCI 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 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 für „Personal access token für CircleCI“ den Wert des persönlichen CircleCI-API-Tokens ein, das du zuvor erstellt hast, und drücke die EINGABETASTE.
    • Drücke bei „Basis-URL der CircleCI-Instanz“ die EINGABETASTE, um den Standardwert (https://circleci.com) zu akzeptieren.
    • Gib als „Name der CircleCI-Organisation“ den Namen für deine CircleCI-Organisation ein, und drücke die EINGABETASTE.

    Ein Beispiel für den Befehl configure:

    $ gh actions-importer configure
✔ Which CI providers are you configuring?: CircleCI
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 CircleCI: ********************
✔ Base url of the CircleCI instance: https://circleci.com
✔ CircleCI organization name: mycircleciorganization
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

Überprüfen von CircleCI

Mit dem Befehl audit rufst du allgemeine Informationen zu allen Projekte in einer CircleCI-Organisation ab.

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

  1. Abrufen aller in einer CircleCI-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

Führe den folgenden Befehl am Terminal aus, um eine CircleCI-Organisation zu überprüfen:

gh actions-importer audit circle-ci --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 falsch konfiguriert und in Bamboo ungü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 potenziellen GitHub Actions-Nutzung

Mit dem Befehl forecast kannst du die potenzielle GitHub Actions-Nutzung vorhersagen, indem du Metriken aus abgeschlossenen Pipelineausführungen in CircleCI 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 circle-ci --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. Mithilfe dieser Metrik kann die Anzahl von Runnern definiert werden, die du konfigurieren solltest.

Darüber hinaus werden diese Metriken für jede Runnerwarteschlange in CircleCI definiert. Dies ist besonders nützlich, wenn es eine Mischung aus gehosteten oder selbstgehosteten Runnern oder Computern mit hoher oder niedriger Leistung gibt, da du spezifische Metriken für verschiedene Runnertypen anzeigen kannst.

Durchführen einer Probelaufmigration einer CircleCI-Pipeline

Mit dem Befehl dry-run kannst du eine CircleCI-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.

Führe für eine Probelaufmigration deines CircleCI-Projekts zu GitHub Actions den folgenden Befehl am Terminal aus, und ersetze dabei my-circle-ci-project durch den Namen des CircleCI-Projekts.

gh actions-importer dry-run circle-ci --output-dir tmp/dry-run --circle-ci-project my-circle-ci-project

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.

Durchführen einer Produktionsmigration einer CircleCI-Pipeline

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

Ausführen des Migrationsbefehls

Um eine CircleCI-Pipeline zu GitHub Actions zu migrieren, führst du den folgenden Befehl am Terminal aus, und ersetzt dabei den Wert von target-url durch die URL deines GitHub-Repositorys und my-circle-ci-project durch den Namen deines CircleCI-Projekts.

gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project

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 circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project
[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'

Ü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 Verweisinformationen zu Umgebungsvariablen, optionalen Argumenten und der unterstützten Syntax, wenn der GitHub Actions Importer für die Migration von CircleCI 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.

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

  • GITHUB_ACCESS_TOKEN: Das personal access token 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)
  • CIRCLE_CI_ACCESS_TOKEN: Das persönliche CircleCI-API-Token für die Authentifizierung bei deiner CircleCI-Instanz
  • CIRCLE_CI_INSTANCE_URL: Die URL der CircleCI-Instanz (z. B. https://circleci.com). Wenn diese Variable nicht festgelegt wurde, wird als Standardwert https://circleci.com verwendet.
  • CIRCLE_CI_ORGANIZATION: Der Organisationsname deiner CircleCI-Instanz
  • CIRCLE_CI_PROVIDER: Der Speicherort der Quelldatei deiner Pipeline (z. B. github). Derzeit wird nur GitHub unterstützt.
  • CIRCLE_CI_SOURCE_GITHUB_ACCESS_TOKEN (optional): Das personal access token zur Authentifizierung bei der Quellinstanz von GitHub (erfordert den Bereich repo). Wenn keine Angabe erfolgt, wird stattdessen der Wert von GITHUB_ACCESS_TOKEN verwendet.
  • CIRCLE_CI_SOURCE_GITHUB_INSTANCE_URL (optional): Die URL zur Quellinstanz von GitHub. Wenn keine Angabe erfolgt, wird stattdessen der Wert von GITHUB_INSTANCE_URL verwendet.

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 --source-file-path-Argument mit den Unterbefehlen forecast, dry-run oder migrate verwenden.

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

Beispiel:

gh actions-importer dry-run circle-ci --output-dir ./output/ --source-file-path ./path/to/.circleci/config.yml

Wenn du beim Ausführen des Unterbefehls forecast mehrere Quelldateien angeben möchtest, kannst du einen Musterabgleich im Dateipfadwert verwenden. Mit gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json übergibst du z. B. alle Quelldateien an den GitHub Actions Importer, die dem Dateipfad ./tmp/previous_forecast/jobs/*.json entsprechen.

--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 Quellcodeverwaltung ab. Das --config-file-path-Argument weist den GitHub Actions Importer an, stattdessen die angegebenen Quelldateien zu verwenden.

Das --config-file-path-Argument kann auch verwendet werden, um anzugeben, zu welchem Repository eine konvertierte zusammengesetzte Aktion migriert werden soll.

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 circle-ci --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml

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

source_files:
  - repository_slug: circle-org-name/circle-project-name
    path: path/to/.circleci/config.yml
  - repository_slug: circle-org-name/some-other-circle-project-name
    path: path/to/.circleci/config.yml
Beispiel für einen Probelauf

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

Die Auswahl der Pipeline erfolgt durch einen Abgleich des repository_slug in der Konfigurationsdatei mit dem Wert der Optionen --circle-ci-organization und --circle-ci-project. Der path wird dann verwendet, um die angegebene Quelldatei zu pullen.

gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml
Angeben des Repositorys konvertierter zusammengesetzter Aktionen

GitHub Actions Importer verwendet die YAML-Datei, die für das --config-file-path-Argument bereitgestellt wird, um das Repository zu bestimmen, zu dem konvertierte zusammengesetzte Aktionen migriert werden.

Zunächst solltest du eine Überwachung ohne das --config-file-path-Argument ausführen:

gh actions-importer audit circle-ci --output-dir ./output/

Die Ausgabe dieses Befehls enthält eine Datei namens config.yml, die eine Liste aller zusammengesetzten Aktionen enthält, die von GitHub Actions Importer konvertiert wurden. Die config.yml-Datei kann beispielsweise den folgenden Inhalt aufweisen:

composite_actions:
  - name: my-composite-action.yml
    target_url: https://github.com/octo-org/octo-repo
    ref: main

Du kannst mit dieser Datei angeben, welchem Repository ein wiederverwendbarer Workflow oder eine zusammengesetzte Aktion hinzugefügt werden soll. Dann kannst du mit dem --config-file-path-Argument die Datei config.yml für GitHub Actions Importer bereitstellen. Beispielsweise kannst du diese Datei verwenden, wenn du einen migrate-Befehl ausführst, um einen Pull Request für jedes eindeutige Repository zu öffnen, das in der Konfigurationsdatei definiert ist:

gh actions-importer migrate circle-ci --circle-ci-project my-project-name --output-dir output/ --config-file-path config.yml --target-url https://github.com/my-org/my-repo

--include-from

Du kannst das --include-from-Argument mit dem Unterbefehl audit verwenden.

Das --include-from-Argument gibt eine Datei an, die eine durch Zeilentrennzeichen getrennte Liste von Repositorys enthält, die in die Überprüfung einer CircleCI-Organisation einbezogen werden sollen. Repositorys, die nicht in der Datei enthalten sind, werden von der Überprüfung ausgeschlossen.

Beispiel:

gh actions-importer audit circle-ci --output-dir ./output/ --include-from repositories.txt

Die für diesen Parameter bereitgestellte Datei muss eine durch Zeilentrennzeichen getrennte Liste von Repositorys sein, z. B.:

repository_one
repository_two
repository_three

Unterstützte Syntax für CircleCI-Pipelines

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

CircleCI-PipelinesGitHub-AktionenStatus
cron-Trigger
  • on.schedule
Unterstützt
Environment
  • env
  • jobs.<job_id>.env
  • jobs.<job_id>.steps.env
Unterstützt
executors
  • runs-on
Unterstützt
jobs
  • jobs
Unterstützt
Auftrag
  • jobs.<job_id>
  • jobs.<job_id>.name
Unterstützt
Matrix
  • jobs.<job_id>.strategy
  • jobs.<job_id>.strategy.matrix
Unterstützt
parameters
  • env
  • workflow-dispatch.inputs
Unterstützt
steps
  • jobs.<job_id>.steps
Unterstützt
when, unless
  • jobs.<job_id>.if
Unterstützt
Trigger
  • on
Unterstützt
executors
  • container
  • services
Teilweise unterstützt
Orbs
  • actions
Teilweise unterstützt
executors
  • self hosted runners
Nicht unterstützt
SetupNicht verfügbarNicht unterstützt
versionNicht verfügbarNicht unterstützt

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

Zuordnung von Umgebungsvariablen

GitHub Actions Importer verwendet die Zuordnungen in der folgenden Tabelle, um die Standardumgebungsvariablen von CircleCI in die passendsten Entsprechung in GitHub Actions zu konvertieren.

CircleCIGitHub-Aktionen
CI$CI
CIRCLE_BRANCH${{ github.ref }}
CIRCLE_JOB${{ github.job }}
CIRCLE_PR_NUMBER${{ github.event.number }}
CIRCLE_PR_REPONAME${{ github.repository }}
CIRCLE_PROJECT_REPONAME${{ github.repository }}
CIRCLE_SHA1${{ github.sha }}
CIRCLE_TAG${{ github.ref }}
CIRCLE_USERNAME${{ github.actor }}
CIRCLE_WORKFLOW_ID${{ github.run_number }}
CIRCLE_WORKING_DIRECTORY${{ github.workspace }}
<< pipeline.id >>${{ github.workflow }}
<< pipeline.number >>${{ github.run_number }}
<< pipeline.project.git_url >>$GITHUB_SERVER_URL/$GITHUB_REPOSITORY
<< pipeline.project.type >>github
<< pipeline.git.tag >>${{ github.ref }}
<< pipeline.git.branch >>${{ github.ref }}
<< pipeline.git.revision >>${{ github.event.pull_request.head.sha }}
<< pipeline.git.base_revision >>${{ github.event.pull_request.base.sha }}

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.