Ă propos de la migration depuis GitLab avec GitHub Actions Importer
Les instructions ci-dessous vous guident tout au long de la configuration de votre environnement pour utiliser GitHub Actions Importer afin de migrer des pipelines GitLab vers GitHub Actions.
Prérequis
- Un compte GitLab ou une organisation avec des pipelines et des travaux que vous souhaitez convertir en workflows GitHub Actions.
- AccÚs pour créer un personal access token GitLab pour votre compte ou organisation.
- Un environnement dans lequel vous pouvez exécuter des conteneurs basés sur Linux et installer les outils nécessaires.
-
Docker est installĂ© et en cours dâexĂ©cution.
-
Lâinterface CLI GitHub est installĂ©e.
Note
Le conteneur GitHub Actions Importer et lâinterface CLI nâont pas besoin dâĂȘtre installĂ©s sur le mĂȘme serveur que votre plateforme CI.
-
Limites
Certaines limitations sâappliquent Ă la migration automatique des processus des pipelines GitLab vers GitHub Actions avec GitHub Actions Importer.
- La mise en cache automatique entre les travaux de diffĂ©rents workflows nâest pas prise en charge.
- La commande
audit
est uniquement prise en charge lors de lâutilisation dâun compte dâorganisation. Toutefois, les commandesdry-run
etmigrate
peuvent ĂȘtre utilisĂ©es avec une organisation ou un compte dâutilisateur.
TĂąches manuelles
Certaines constructions GitLab doivent ĂȘtre migrĂ©es manuellement. Il sâagit notamment des paramĂštres suivants :
- Valeurs de variables de groupe ou de projet masquées
- Rapports dâartefact
Pour plus dâinformations sur les migrations manuelles, consultez « Migration de GitLab CI/CD vers GitHub Actions ».
Installation de lâextension CLI GitHub Actions Importer
-
Installez lâextension CLI GitHub Actions Importer :
Bash gh extension install github/gh-actions-importer
gh extension install github/gh-actions-importer
-
VĂ©rifiez que lâextension est installĂ©e :
$ 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.
Configuration des informations dâidentification
La commande CLI configure
est utilisĂ©e pour dĂ©finir les informations dâidentification et les options requises pour GitHub Actions Importer lors de lâutilisation de GitLab et de GitHub.
-
CrĂ©ez un personal access token (classic) GitHub. Pour plus dâinformations, consultez « Gestion de vos jetons d'accĂšs personnels ».
Votre jeton doit avoir lâĂ©tendue
workflow
.AprĂšs avoir crĂ©Ă© le jeton, copiez-le et enregistrez-le en lieu sĂ»r en vue de lâutiliser ultĂ©rieurement.
-
CrĂ©er un personal access token GitLab. Pour plus dâinformations, consultez Personal access tokens dans la documentation GitLab.
Votre jeton doit avoir lâĂ©tendue
read_api
.AprĂšs avoir crĂ©Ă© le jeton, copiez-le et enregistrez-le en lieu sĂ»r en vue de lâutiliser ultĂ©rieurement.
-
Dans votre terminal, exécutez la commande CLI GitHub Actions Importer
configure
 :gh actions-importer configure
La commande
configure
vous invite à entrer les informations suivantes :- Pour « Quels fournisseurs CI configurez-vous ? », utilisez les touches de direction pour sélectionner
GitLab
, appuyez sur Espace pour le sélectionner, puis appuyez sur Entrée. - Pour « Personal access token pour GitHub », entrez la valeur du personal access token (classic) que vous avez créé, puis appuyez sur Entrée.
- Pour « URL de base de lâinstance GitHub », entrez lâURL de votre instance GitHub Enterprise Server, puis appuyez sur EntrĂ©e.
- Pour « Jeton privé pour GitLab », entrez la valeur du personal access token GitLab que vous avez créé précédemment, puis appuyez sur Entrée.
- Pour « URL de base de lâinstance GitLab », entrez lâURL de votre instance GitLab, puis appuyez sur EntrĂ©e.
Voici un exemple de sortie de la commande
configure
.$ gh actions-importer configure â Which CI providers are you configuring?: GitLab Enter the following values (leave empty to omit): â Personal access token for GitHub: *************** â Base url of the GitHub instance: https://github.com â Private token for GitLab: *************** â Base url of the GitLab instance: http://localhost Environment variables successfully updated.
- Pour « Quels fournisseurs CI configurez-vous ? », utilisez les touches de direction pour sélectionner
-
Dans votre terminal, exécutez la commande CLI GitHub Actions Importer
update
pour vous connecter au Container registry GitHub Packages et vĂ©rifier que lâimage conteneur est mise Ă jour vers la derniĂšre version :gh actions-importer update
La sortie de la commande devrait ressembler à la sortie ci-dessous :
Updating ghcr.io/actions-importer/cli:latest... ghcr.io/actions-importer/cli:latest up-to-date
Effectuer un audit de GitLab
Vous pouvez utiliser la commande audit
pour obtenir une vue dâensemble de tous les pipelines dâun serveur GitLab.
La commande audit
effectue les étapes suivantes :
- Extrait tous les projets définis dans un serveur GitLab.
- Convertit chaque pipeline en son workflow GitHub Actions Ă©quivalent.
- GĂ©nĂšre un rapport qui rĂ©sume la complexitĂ© et lâexhaustivitĂ© dâune migration avec GitHub Actions Importer.
PrĂ©requis pour la commande dâaudit
Pour utiliser la commande audit
, vous devez disposer dâun personal access token configurĂ© avec un compte dâorganisation GitLab.
Exécution de la commande audit
Pour effectuer un audit dâun serveur GitLab, exĂ©cutez la commande suivante dans votre terminal, en remplaçant my-gitlab-namespace
par lâespace de noms ou le groupe que vous auditez :
gh actions-importer audit gitlab --output-dir tmp/audit --namespace my-gitlab-namespace
Inspection des rĂ©sultats de lâaudit
Les fichiers dans le rĂ©pertoire de sortie spĂ©cifiĂ© contiennent les rĂ©sultats de lâaudit. Consultez le fichier audit_summary.md
pour obtenir un rĂ©sumĂ© des rĂ©sultats de lâaudit.
Le rĂ©sumĂ© de lâaudit comporte les sections suivantes.
Pipelines
La section « Pipelines » contient des statistiques générales concernant le taux de conversion effectué par GitHub Actions Importer.
Vous trouverez ci-dessous quelques termes clés qui peuvent apparaßtre dans la section « Pipelines » :
- Les pipelines réussis sont ceux dont 100 % des constructions de pipeline et des éléments individuels ont été convertis automatiquement en leur équivalent GitHub Actions.
- Les pipelines partiellement rĂ©ussis sont ceux dont la totalitĂ© des constructions de pipeline ont Ă©tĂ© converties ; toutefois, certains Ă©lĂ©ments individuels nâont pas Ă©tĂ© convertis automatiquement en leur Ă©quivalent GitHub Actions.
- Les pipelines non pris en charge sont des types de définition qui ne sont pas pris en charge par GitHub Actions Importer.
- Les pipelines ayant Ă©chouĂ© sont ceux qui ont rencontrĂ© une erreur irrĂ©cupĂ©rable lors de la conversion. Cela peut se produire pour lâune des trois raisons suivantes :
- Le pipeline a Ă©tĂ© mal configurĂ© Ă lâorigine et nâĂ©tait pas valide.
- GitHub Actions Importer a rencontré une erreur interne lors de sa conversion.
- Une rĂ©ponse rĂ©seau infructueuse a rendu le pipeline inaccessible, ce qui est souvent dĂ» Ă des informations dâidentification non valides.
Ătapes de gĂ©nĂ©ration
La section « Ătapes de gĂ©nĂ©ration » contient une vue dâensemble des Ă©tapes de gĂ©nĂ©ration individuelles utilisĂ©es dans tous les pipelines ainsi que le nombre dâĂ©tapes converties automatiquement par GitHub Actions Importer.
Vous trouverez ci-dessous quelques termes clĂ©s qui peuvent apparaĂźtre dans la section « Ătapes de gĂ©nĂ©ration » :
- Une étape de génération connue est une étape qui a été automatiquement convertie en action équivalente.
- Une Ă©tape de gĂ©nĂ©ration inconnue est une Ă©tape qui nâa pas Ă©tĂ© automatiquement convertie en action Ă©quivalente.
- Une étape de génération non prise en charge est une étape qui est :
- Fondamentalement non prise en charge par GitHub Actions.
- ConfigurĂ© dâune maniĂšre incompatible avec GitHub Actions.
- Une action est une liste des actions qui ont Ă©tĂ© utilisĂ©es dans les workflows convertis. Cela peut ĂȘtre important pour :
- Rassembler la liste des actions Ă synchroniser avec votre instance, si vous utilisez GitHub Enterprise Server.
- DĂ©finir une liste dâautorisation au niveau de lâorganisation des actions utilisĂ©es. Cette liste dâactions est une liste complĂšte dâactions que vos Ă©quipes de sĂ©curitĂ© ou de conformitĂ© peuvent avoir besoin dâexaminer.
TĂąches manuelles
La section « TĂąches manuelles » contient une vue dâensemble des tĂąches que GitHub Actions Importer ne peut pas accomplir automatiquement et que vous devez effectuer manuellement.
Vous trouverez ci-dessous quelques termes clés qui peuvent apparaßtre dans la section « Tùches manuelles » :
- Un secret est un secret au niveau de lâorganisation ou du dĂ©pĂŽt qui est utilisĂ© dans les pipelines convertis. Ces secrets doivent ĂȘtre crĂ©Ă©s manuellement dans GitHub Actions pour que ces pipelines fonctionnent correctement. Pour plus dâinformations, consultez « Utilisation de secrets dans GitHub Actions ».
- Un exĂ©cuteur auto-hĂ©bergĂ© fait rĂ©fĂ©rence Ă une Ă©tiquette dâun exĂ©cuteur rĂ©fĂ©rencĂ© dans un pipeline converti qui nâest pas un exĂ©cuteur hĂ©bergĂ© par GitHub. Vous devez dĂ©finir manuellement ces exĂ©cuteurs pour que ces pipelines fonctionnent correctement.
Fichiers
La derniĂšre section du rapport dâaudit fournit un manifeste de tous les fichiers qui ont Ă©tĂ© Ă©crits sur le disque pendant lâaudit.
Ă chaque fichier de pipeline correspond une sĂ©rie de fichiers inclus dans lâaudit, notamment :
- Le pipeline dâorigine tel quâil a Ă©tĂ© dĂ©fini dans GitHub.
- Toutes les réponses réseau utilisées pour convertir le pipeline.
- Le fichier de workflow converti.
- Les traces de pile qui peuvent ĂȘtre utilisĂ©es pour rĂ©soudre les problĂšmes liĂ©s Ă une conversion de pipeline ayant Ă©chouĂ©.
De plus, le fichier workflow_usage.csv
contient une liste sĂ©parĂ©e par des virgules de lâensemble des actions, secrets et exĂ©cuteurs qui sont utilisĂ©s par chaque pipeline converti avec succĂšs. Cela peut ĂȘtre utile pour dĂ©terminer quels workflows utilisent quelles actions, quels secrets ou quels exĂ©cuteurs, et pour effectuer des rĂ©visions de sĂ©curitĂ©.
PrĂ©voir lâutilisation potentielle de lâexĂ©cuteur de gĂ©nĂ©ration
Vous pouvez utiliser la commande forecast
pour prĂ©voir lâutilisation potentielle de GitHub Actions en calculant des mĂ©triques Ă partir des exĂ©cutions de pipeline terminĂ©es sur votre serveur GitLab.
Exécution de la commande forecast
Pour effectuer une prĂ©vision de lâutilisation potentielle de GitHub Actions, exĂ©cutez la commande suivante dans votre terminal, en remplaçant my-gitlab-namespace
par lâespace de noms ou le groupe que vous prĂ©disez. Par dĂ©faut, GitHub Actions Importer inclut les sept jours prĂ©cĂ©dents dans le rapport de prĂ©vision.
gh actions-importer forecast gitlab --output-dir tmp/forecast --namespace my-gitlab-namespace
PrĂ©vision dâun espace de noms entier
Pour prĂ©dire un espace de noms entier et tous ses sous-groupes, vous devez spĂ©cifier chaque sous-groupe dans lâargument --namespace
ou la variable dâenvironnement NAMESPACE
.
Par exemple :
gh actions-importer forecast gitlab --namespace my-gitlab-namespace my-gitlab-namespace/subgroup-one my-gitlab-namespace/subgroup-two ...
Inspection du rapport de prévision
Le fichier forecast_report.md
dans le répertoire de sortie spécifié contient les résultats de la prévision.
Voici quelques termes clés qui peuvent apparaßtre dans le rapport de prévision :
- Le nombre de travaux correspond au nombre total de travaux terminés.
- Le nombre de pipelines correspond au nombre de pipelines uniques utilisés.
- Le temps dâexĂ©cution dĂ©crit le temps passĂ© par un exĂ©cuteur sur un travail. Cette mĂ©trique peut ĂȘtre utilisĂ©e pour planifier le coĂ»t des exĂ©cuteurs hĂ©bergĂ©s par GitHub.
- Cette métrique est corrélée au montant que vous devez vous attendre à dépenser dans GitHub Actions. Cela varie en fonction du matériel utilisé pendant ces minutes. Vous pouvez utiliser la calculatrice de prix GitHub Actions pour estimer les coûts.
- Les mĂ©triques de temps de file dâattente dĂ©crivent le temps passĂ© par un travail Ă attendre quâun exĂ©cuteur soit disponible pour lâexĂ©cuter.
- Les mĂ©triques de travaux simultanĂ©s dĂ©crivent le nombre de travaux en cours dâexĂ©cution Ă un moment donnĂ©. Cette mĂ©trique peut ĂȘtre utilisĂ©e pour dĂ©finir le nombre dâexĂ©cuteurs que vous devez configurer.
En outre, ces mĂ©triques sont dĂ©finies pour chaque file dâattente dâexĂ©cuteurs dans GitLab. Câest particuliĂšrement utile sâil existe une combinaison dâexĂ©cuteurs hĂ©bergĂ©s ou auto-hĂ©bergĂ©s ou de machines Ă spĂ©cifications Ă©levĂ©es ou faibles, afin que vous puissiez voir des mĂ©triques spĂ©cifiques Ă diffĂ©rents types dâexĂ©cuteurs.
Effectuer une migration test dâun pipeline GitLab
Vous pouvez utiliser la commande dry-run
pour convertir un pipeline GitLab en son workflow GitHub Actions Ă©quivalent.
Exécution de la commande dry-run
Vous pouvez utiliser la commande dry-run
pour convertir un pipeline GitLab en workflow GitHub Actions Ă©quivalent. Une exĂ©cution test crĂ©e les fichiers de sortie dans un rĂ©pertoire spĂ©cifiĂ©, mais nâouvre pas de demande de tirage pour migrer le pipeline.
Pour effectuer une exécution de test de migration de vos pipelines GitLab vers GitHub Actions, exécutez la commande suivante dans votre terminal, en remplaçant my-gitlab-project
par le slug de votre projet GitLab et my-gitlab-namespace
par lâespace de noms ou le groupe (le chemin dâaccĂšs complet au groupe pour les sous-groupes, par ex. my-org/my-team
) pour lequel vous effectuez une exécution de test.
gh actions-importer dry-run gitlab --output-dir tmp/dry-run --namespace my-gitlab-namespace --project my-gitlab-project
Inspection des workflows convertis
Vous pouvez afficher les journaux de lâexĂ©cution test et les fichiers de workflow convertis dans le rĂ©pertoire de sortie spĂ©cifiĂ©.
Pour tout ce que GitHub Actions Importer nâa pas pu convertir automatiquement, comme des Ă©tapes de gĂ©nĂ©ration inconnues ou un pipeline partiellement rĂ©ussi, vous pouvez crĂ©er des transformateurs personnalisĂ©s pour personnaliser davantage le processus de conversion. Pour plus dâinformations, consultez « Extension GitHub Actions Importer avec des transformateurs personnalisĂ©s ».
Effectuer une migration de production dâun pipeline GitLab
Vous pouvez utiliser la commande migrate
pour convertir un pipeline GitLab et ouvrir une demande de tirage avec le workflow GitHub Actions Ă©quivalent.
Exécution de la commande migrate
Pour migrer un pipeline GitLab vers GitHub Actions, exécutez la commande suivante dans votre terminal, en remplaçant les valeurs suivantes :
- La valeur
target-url
avec lâURL de votre dĂ©pĂŽt GitHub Enterprise Server my-gitlab-project
avec le slug de votre projet GitLabmy-gitlab-namespace
avec lâespace de noms ou le groupe vers lequel vous migrez (chemin complet pour les sous-groupes, par ex.my-org/my-team
)
gh actions-importer migrate gitlab --target-url https://github.com/:owner/:repo --output-dir tmp/migrate --namespace my-gitlab-namespace --project my-gitlab-project
La sortie de la commande inclut lâURL de la demande de tirage qui ajoute le workflow converti Ă votre dĂ©pĂŽt. Voici un exemple de sortie rĂ©ussie :
$ gh actions-importer migrate gitlab --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --namespace octo-org --project monas-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'
Inspection de la demande de tirage
La sortie dâune exĂ©cution rĂ©ussie de la commande migrate
contient un lien vers la nouvelle demande de tirage qui ajoute le workflow converti à votre dépÎt.
Voici quelques éléments importants de la demande de tirage :
- Dans la description de la demande de tirage, une section appelĂ©e Ătapes manuelles, qui liste les Ă©tapes que vous devez effectuer manuellement avant de pouvoir terminer la migration de vos pipelines vers GitHub Actions. Par exemple, cette section peut vous indiquer de crĂ©er des secrets utilisĂ©s dans vos workflows.
- Fichier de workflows converti. SĂ©lectionnez lâonglet Fichiers changĂ©s dans la demande de tirage pour afficher le fichier de workflow Ă ajouter Ă votre dĂ©pĂŽt GitHub Enterprise Server.
Une fois que vous avez terminĂ© dâinspecter la demande de tirage, vous pouvez la fusionner pour ajouter le workflow Ă votre dĂ©pĂŽt GitHub Enterprise Server.
Informations de référence
Cette section contient des informations de rĂ©fĂ©rence sur les variables dâenvironnement, les arguments facultatifs et la syntaxe prise en charge lors de lâutilisation de GitHub Actions Importer pour effectuer une migration Ă partir de GitLab.
Utilisation de variables dâenvironnement
GitHub Actions Importer utilise des variables dâenvironnement pour sa configuration dâauthentification. Ces variables sont dĂ©finies lors du processus de configuration au moyen de la commande configure
. Pour plus dâinformations, consultez la section « Configuration des informations dâidentification ».
GitHub Actions Importer utilise les variables dâenvironnement suivantes pour se connecter Ă votre instance GitLab :
GITHUB_ACCESS_TOKEN
 : personal access token (classic) utilisĂ© pour crĂ©er des demandes de tirage avec un workflow converti (nĂ©cessite lâĂ©tendueworkflow
).GITHUB_INSTANCE_URL
 : URL de lâinstance GitHub cible (par exemple,https://github.com
).GITLAB_ACCESS_TOKEN
 : Le personal access token GitLab utilisé pour afficher les ressources GitLab.GITLAB_INSTANCE_URL
 : URL de lâinstance GitLab.NAMESPACE
 : espaces de noms ou groupes qui contiennent les pipelines GitLab.
Ces variables dâenvironnement peuvent ĂȘtre spĂ©cifiĂ©es dans un fichier .env.local
chargé par GitHub Actions Importer lors de son exécution.
Utilisation des arguments facultatifs
Vous pouvez utiliser des arguments facultatifs avec les sous-commandes GitHub Actions Importer pour personnaliser votre migration.
--source-file-path
Vous pouvez utiliser lâargument --source-file-path
avec les sous-commandes forecast
, dry-run
ou migrate
.
Par dĂ©faut, GitHub Actions Importer rĂ©cupĂšre le contenu du pipeline Ă partir du contrĂŽle de code source. Lâargument --source-file-path
indique Ă GitHub Actions Importer dâutiliser le chemin du fichier source spĂ©cifiĂ© Ă la place.
Par exemple :
gh actions-importer dry-run gitlab --output-dir output/ --namespace my-gitlab-namespace --project my-gitlab-project --source-file-path path/to/.gitlab-ci.yml
Si vous souhaitez fournir plusieurs fichiers sources lors de lâexĂ©cution de la sous-commande forecast
, vous pouvez utiliser la correspondance de modĂšle dans la valeur du chemin de fichier. Lâexemple suivant fournit Ă GitHub Actions Importer tous les fichiers sources qui correspondent au chemin de fichier ./tmp/previous_forecast/jobs/*.json
.
gh actions-importer forecast gitlab --output-dir output/ --namespace my-gitlab-namespace --project my-gitlab-project --source-file-path ./tmp/previous_forecast/jobs/*.json
--config-file-path
Vous pouvez utiliser lâargument --config-file-path
avec les sous-commandes audit
, dry-run
et migrate
.
Par dĂ©faut, GitHub Actions Importer rĂ©cupĂšre le contenu du pipeline Ă partir du contrĂŽle de code source. Lâargument --config-file-path
indique Ă GitHub Actions Importer dâutiliser les fichiers sources spĂ©cifiĂ©s Ă la place.
Lâargument --config-file-path
peut Ă©galement ĂȘtre utilisĂ© pour spĂ©cifier le rĂ©fĂ©rentiel vers lequel un workflow rĂ©utilisable converti doit ĂȘtre migrĂ©.
Exemple Audit
Dans cet exemple, GitHub Actions Importer utilise le fichier de configuration YAML spécifié pour effectuer un audit.
gh actions-importer audit gitlab --output-dir path/to/output/ --namespace my-gitlab-namespace --config-file-path path/to/gitlab/config.yml
Pour auditer une instance GitLab avec un fichier de configuration, celui-ci doit ĂȘtre au format suivant et chaque valeur repository_slug
doit ĂȘtre unique :
source_files:
- repository_slug: namespace/project-name
path: path/to/.gitlab-ci.yml
- repository_slug: namespace/some-other-project-name
path: path/to/.gitlab-ci.yml
Exemple dâexĂ©cution test
Dans cet exemple, GitHub Actions Importer utilise le fichier de configuration YAML spécifié comme fichier source pour effectuer une exécution test.
Le pipeline est sélectionné en faisant correspondre le repository_slug
dans le fichier de configuration Ă la valeur des options --namespace
et --project
. path
est ensuite utilisé pour tirer (pull) le fichier source spécifié.
gh actions-importer dry-run gitlab --namespace my-gitlab-namespace --project my-gitlab-project-name --output-dir ./output/ --config-file-path ./path/to/gitlab/config.yml
Spécifier le référentiel des workflows réutilisables convertis
GitHub Actions Importer utilise le fichier YAML fourni Ă lâargument --config-file-path
pour déterminer le référentiel vers lequel les workflows réutilisables convertis sont migrés.
Pour commencer, vous devez exĂ©cuter un audit sans lâargument --config-file-path
:
gh actions-importer audit gitlab --output-dir ./output/
La sortie de cette commande contient un fichier nommé config.yml
qui contient lui-mĂȘme une liste de toutes les actions composites qui ont Ă©tĂ© converties par GitHub Actions Importer. Par exemple, le fichier config.yml
peut avoir le contenu suivant :
reusable_workflows:
- name: my-reusable-workflow.yml
target_url: https://github.com/octo-org/octo-repo
ref: main
Vous pouvez utiliser ce fichier pour spĂ©cifier le rĂ©fĂ©rentiel et la rĂ©fĂ©rence auxquels un workflow rĂ©utilisable ou une action composite doit ĂȘtre ajoutĂ©. Vous pouvez ensuite utiliser lâargument --config-file-path
pour fournir le fichier config.yml
Ă GitHub Actions Importer. Par exemple, vous pouvez utiliser ce fichier lors de lâexĂ©cution dâune commande migrate
pour ouvrir une demande de tirage pour chaque référentiel unique défini dans le fichier config :
gh actions-importer migrate gitlab --project my-project-name --output-dir output/ --config-file-path config.yml --target-url https://github.com/my-org/my-repo
Syntaxe prise en charge pour les pipelines GitLab
Le tableau suivant montre le type de propriĂ©tĂ©s que GitHub Actions Importer est en mesure de convertir. Pour plus dâinformations sur lâalignement de la syntaxe des pipelines GitLab sur GitHub Actions, consultez « Migration de GitLab CI/CD vers GitHub Actions ».
Pipelines GitLab | GitHub Actions | Ătat |
---|---|---|
after_script | jobs.<job_id>.steps | Prise en charge |
auto_cancel_pending_pipelines | concurrency | Prise en charge |
before_script | jobs.<job_id>.steps | Prise en charge |
build_timeout ou timeout | jobs.<job_id>.timeout-minutes | Prise en charge |
default | Non applicable | Prise en charge |
image | jobs.<job_id>.container | Prise en charge |
job | jobs.<job_id> | Prise en charge |
needs | jobs.<job_id>.needs | Prise en charge |
only_allow_merge_if_pipeline_succeeds | on.pull_request | Prise en charge |
resource_group | jobs.<job_id>.concurrency | Prise en charge |
schedule | on.schedule | Prise en charge |
script | jobs.<job_id>.steps | Prise en charge |
stages | jobs | Prise en charge |
tags | jobs.<job_id>.runs-on | Prise en charge |
variables | env , jobs.<job_id>.env | Prise en charge |
Exécuter des pipelines pour les nouvelles validations | on.push | Prise en charge |
Exécuter des pipelines manuellement | on.workflow_dispatch | Prise en charge |
environment | jobs.<job_id>.environment | Partiellement pris en charge |
include | Les fichiers rĂ©fĂ©rencĂ©s dans une instruction include sont fusionnĂ©s dans un graphique de travail unique avant dâĂȘtre transformĂ©s. | Partiellement pris en charge |
only ou except | jobs.<job_id>.if | Partiellement pris en charge |
parallel | jobs.<job_id>.strategy | Partiellement prise en charge |
rules | jobs.<job_id>.if | Partiellement prise en charge |
services | jobs.<job_id>.services | Partiellement prise en charge |
workflow | if | Partiellement pris en charge |
Pour plus dâinformations sur les constructions GitLab prises en charge, consultez le dĂ©pĂŽt github/gh-actions-importer
.
Syntaxe des variables dâenvironnement
GitHub Actions Importer utilise le mappage dans le tableau ci-dessous pour convertir les variables dâenvironnement GitLab par dĂ©faut en lâĂ©quivalent le plus proche dans GitHub Actions.
GitLab | GitHub Actions |
---|---|
CI_API_V4_URL | ${{ github.api_url }} |
CI_BUILDS_DIR | ${{ github.workspace }} |
CI_COMMIT_BRANCH | ${{ github.ref }} |
CI_COMMIT_REF_NAME | ${{ github.ref }} |
CI_COMMIT_REF_SLUG | ${{ github.ref }} |
CI_COMMIT_SHA | ${{ github.sha }} |
CI_COMMIT_SHORT_SHA | ${{ github.sha }} |
CI_COMMIT_TAG | ${{ github.ref }} |
CI_JOB_ID | ${{ github.job }} |
CI_JOB_MANUAL | ${{ github.event_name == 'workflow_dispatch' }} |
CI_JOB_NAME | ${{ github.job }} |
CI_JOB_STATUS | ${{ job.status }} |
CI_JOB_URL | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |
CI_JOB_TOKEN | ${{ github.token }} |
CI_NODE_INDEX | ${{ strategy.job-index }} |
CI_NODE_TOTAL | ${{ strategy.job-total }} |
CI_PIPELINE_ID | ${{ github.repository}}/${{ github.workflow }} |
CI_PIPELINE_IID | ${{ github.workflow }} |
CI_PIPELINE_SOURCE | ${{ github.event_name }} |
CI_PIPELINE_TRIGGERED | ${{ github.actions }} |
CI_PIPELINE_URL | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |
CI_PROJECT_DIR | ${{ github.workspace }} |
CI_PROJECT_ID | ${{ github.repository }} |
CI_PROJECT_NAME | ${{ github.event.repository.name }} |
CI_PROJECT_NAMESPACE | ${{ github.repository_owner }} |
CI_PROJECT_PATH_SLUG | ${{ github.repository }} |
CI_PROJECT_PATH | ${{ github.repository }} |
CI_PROJECT_ROOT_NAMESPACE | ${{ github.repository_owner }} |
CI_PROJECT_TITLE | ${{ github.event.repository.full_name }} |
CI_PROJECT_URL | ${{ github.server_url }}/${{ github.repository }} |
CI_REPOSITORY_URL | ${{ github.event.repository.clone_url }} |
CI_RUNNER_EXECUTABLE_ARCH | ${{ runner.os }} |
CI_SERVER_HOST | ${{ github.server_url }} |
CI_SERVER_URL | ${{ github.server_url }} |
CI_SERVER | ${{ github.actions }} |
GITLAB_CI | ${{ github.actions }} |
GITLAB_USER_EMAIL | ${{ github.actor }} |
GITLAB_USER_ID | ${{ github.actor }} |
GITLAB_USER_LOGIN | ${{ github.actor }} |
GITLAB_USER_NAME | ${{ github.actor }} |
TRIGGER_PAYLOAD | ${{ github.event_path }} |
CI_MERGE_REQUEST_ASSIGNEES | ${{ github.event.pull_request.assignees }} |
CI_MERGE_REQUEST_ID | ${{ github.event.pull_request.number }} |
CI_MERGE_REQUEST_IID | ${{ github.event.pull_request.number }} |
CI_MERGE_REQUEST_LABELS | ${{ github.event.pull_request.labels }} |
CI_MERGE_REQUEST_MILESTONE | ${{ github.event.pull_request.milestone }} |
CI_MERGE_REQUEST_PROJECT_ID | ${{ github.repository }} |
CI_MERGE_REQUEST_PROJECT_PATH | ${{ github.repository }} |
CI_MERGE_REQUEST_PROJECT_URL | ${{ github.server_url }}/${{ github.repository }} |
CI_MERGE_REQUEST_REF_PATH | ${{ github.ref }} |
CI_MERGE_REQUEST_SOURCE_BRANCH_NAME | ${{ github.event.pull_request.head.ref }} |
CI_MERGE_REQUEST_SOURCE_BRANCH_SHA | ${{ github.event.pull_request.head.sha}} |
CI_MERGE_REQUEST_SOURCE_PROJECT_ID | ${{ github.event.pull_request.head.repo.full_name }} |
CI_MERGE_REQUEST_SOURCE_PROJECT_PATH | ${{ github.event.pull_request.head.repo.full_name }} |
CI_MERGE_REQUEST_SOURCE_PROJECT_URL | ${{ github.event.pull_request.head.repo.url }} |
CI_MERGE_REQUEST_TARGET_BRANCH_NAME | ${{ github.event.pull_request.base.ref }} |
CI_MERGE_REQUEST_TARGET_BRANCH_SHA | ${{ github.event.pull_request.base.sha }} |
CI_MERGE_REQUEST_TITLE | ${{ github.event.pull_request.title }} |
CI_EXTERNAL_PULL_REQUEST_IID | ${{ github.event.pull_request.number }} |
CI_EXTERNAL_PULL_REQUEST_SOURCE_REPOSITORY | ${{ github.event.pull_request.head.repo.full_name }} |
CI_EXTERNAL_PULL_REQUEST_TARGET_REPOSITORY | ${{ github.event.pull_request.base.repo.full_name }} |
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_NAME | ${{ github.event.pull_request.head.ref }} |
CI_EXTERNAL_PULL_REQUEST_SOURCE_BRANCH_SHA | ${{ github.event.pull_request.head.sha }} |
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_NAME | ${{ github.event.pull_request.base.ref }} |
CI_EXTERNAL_PULL_REQUEST_TARGET_BRANCH_SHA | ${{ github.event.pull_request.base.sha }} |
Mentions légales
Certaines parties ont été adaptées à partir de https://github.com/github/gh-actions-importer/ sous la licence MIT :
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.