Migrating from Azure DevOps with GitHub Actions Importer

Legal notice

About migrating from Azure DevOps with GitHub Actions Importer

The instructions below will guide you through configuring your environment to use GitHub Actions Importer to migrate Azure DevOps pipelines to GitHub Actions.

Prerequisites

• An Azure DevOps account or organization with projects and pipelines that you want to convert to GitHub Actions workflows.
• Access to create an Azure DevOps personal access token for your account or organization.
• Un entorno en el que puedas ejecutar contenedores basados en Linux e instalar las herramientas necesarias.

  • Docker está instalado y funcionando.

  • La CLI de GitHub está instalada.

  Nota:

  El contenedor y la CLI de GitHub Actions Importer no deben estar instalados en el mismo servidor que tu plataforma de CI.

Limitations

There are some limitations when migrating from Azure DevOps to GitHub Actions with GitHub Actions Importer:

• GitHub Actions Importer requires version 5.0 of the Azure DevOps API, available in either Azure DevOps Services or Azure DevOps Server 2019. Older versions of Azure DevOps Server are not compatible.
• Tasks that are implicitly added to an Azure DevOps pipeline, such as checking out source code, may be added to a GitHub Actions Importer audit as a GUID name. To find the friendly task name for a GUID, you can use the following URL: https://dev.azure.com/:organization/_apis/distributedtask/tasks/:guid.

Manual tasks

Certain Azure DevOps constructs must be migrated manually from Azure DevOps into GitHub Actions configurations. These include:

• Organization, repository, and environment secrets
• Service connections such as OIDC Connect, GitHub Apps, and personal access tokens
• Unknown tasks
• Self-hosted agents
• Environments
• Pre-deployment approvals

For more information on manual migrations, see Migrating from Azure Pipelines to GitHub Actions.

Unsupported tasks

GitHub Actions Importer does not support migrating the following tasks:

• Pre-deployment gates
• Post-deployment gates
• Post-deployment approvals
• Some resource triggers

Installing the GitHub Actions Importer CLI extension

1. Instala la extensión de la CLI del GitHub Actions Importer:

   Bash

   gh extension install github/gh-actions-importer
   

2. Comprueba que la extensión está instalada:

   $ 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.
   

Configuring credentials

The configure CLI command is used to set required credentials and options for GitHub Actions Importer when working with Azure DevOps and GitHub.

1. Create a GitHub personal access token (classic). For more information, see Administración de tokens de acceso personal.

   Your token must have the workflow scope.

   After creating the token, copy it and save it in a safe location for later use.

2. Create an Azure DevOps personal access token. For more information, see Use personal access tokens in the Azure DevOps documentation. The token must have the following scopes:

   • Agents Pool: Read
   • Build: Read
   • Code: Read
   • Release: Read
   • Service Connections: Read
   • Task Groups: Read
   • Variable Groups: Read

   After creating the token, copy it and save it in a safe location for later use.

3. In your terminal, run the GitHub Actions Importer configure CLI command:

   gh actions-importer configure
   

   The configure command will prompt you for the following information:

   • For "Which CI providers are you configuring?", use the arrow keys to select Azure DevOps, press Space to select it, then press Enter.
   • For "Personal access token for GitHub", enter the value of the personal access token (classic) that you created earlier, and press Enter.
   • For "Base url of the GitHub instance", enter the URL for tu instancia de GitHub Enterprise Server, and press Enter.
   • For "Personal access token for Azure DevOps", enter the value for the Azure DevOps personal access token that you created earlier, and press Enter.
   • For "Base url of the Azure DevOps instance", press Enter to accept the default value (https://dev.azure.com).
   • For "Azure DevOps organization name", enter the name for your Azure DevOps organization, and press Enter.
   • For "Azure DevOps project name", enter the name for your Azure DevOps project, and press Enter.

   An example of the configure command is shown below:

   $ gh actions-importer configure
   ✔ Which CI providers are you configuring?: Azure DevOps
   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 Azure DevOps: ***************
   ✔ Base url of the Azure DevOps instance: https://dev.azure.com
   ✔ Azure DevOps organization name: :organization
   ✔ Azure DevOps project name: :project
   Environment variables successfully updated.
   

4. In your terminal, run the GitHub Actions Importer update CLI command to connect to the GitHub Packages Container registry and ensure that the container image is updated to the latest version:

   gh actions-importer update
   

   The output of the command should be similar to below:

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

Perform an audit of Azure DevOps

You can use the audit command to get a high-level view of all projects in an Azure DevOps organization.

The audit command performs the following steps:

1. Fetches all of the projects defined in an Azure DevOps organization.
2. Converts each pipeline to its equivalent GitHub Actions workflow.
3. Generates a report that summarizes how complete and complex of a migration is possible with GitHub Actions Importer.

Running the audit command

To perform an audit of an Azure DevOps organization, run the following command in your terminal:

gh actions-importer audit azure-devops --output-dir tmp/audit

Inspecting the audit results

Los archivos del directorio de salida especificado contienen los resultados de la auditoría. Consulta el archivo audit_summary.md para obtener un resumen de los resultados de la auditoría.

El resumen de la auditoría tiene las secciones siguientes.

Pipelines

La sección "Canalizaciones" contiene estadísticas de alto nivel con respecto a la tasa de conversión realizada por GitHub Actions Importer.

A continuación se incluyen algunos términos clave que pueden aparecer en la sección "Canalizaciones":

• En las canalizaciones correctas, el 100 % de las construcciones de canalización y los elementos individuales se convirtieron automáticamente en sus GitHub Actions equivalentes.
• En las canalizaciones parcialmente correctas, se convirtieron todas sus construcciones de canalización, pero algunos elementos individuales no se convirtieron automáticamente en sus GitHub Actions equivalentes.
• Las canalizaciones no admitidas son tipos de definición que no son compatibles con GitHub Actions Importer.
• En las canalizaciones con error, se produjo un error grave al realizar la conversión. Esto puede deberse a uno de los siguientes motivos:
  • La canalización se configuró mal originalmente y no es válida.
  • GitHub Actions Importer encontró un error interno al convertirla.
  • Se produjo una respuesta de red incorrecta que hizo que la canalización fuera inaccesible, lo que a menudo se debe a credenciales no válidas.

Pasos de compilación

La sección "Pasos de compilación" contiene información general sobre los pasos de compilación individuales que se usan en todas las canalizaciones y cuántos se han convertido automáticamente mediante GitHub Actions Importer.

A continuación se incluyen algunos términos clave que pueden aparecer en la sección "Pasos de compilación":

• Un paso de compilación conocido es un paso que se ha convertido automáticamente en una acción equivalente.
• Un paso de compilación desconocido es un paso que no se ha convertido automáticamente en una acción equivalente.
• Un paso de compilación no admitido es un paso que:
  • Esencialmente, no es compatible con GitHub Actions.
  • Se ha configurado de una manera que es incompatible con GitHub Actions.
• Una acción es una lista de las acciones que se han usado en los flujos de trabajo convertidos. Esto puede ser importante por las siguientes razones:
  • Si usas GitHub Enterprise Server, recopilar la lista de acciones que se deben sincronizar con la instancia.
  • Definir una lista de permitidos de nivel de organización de las acciones que se usan. Esta lista de acciones es una lista completa de las acciones que puede que los equipos de seguridad o cumplimiento deban revisar.

Tareas manuales

La sección "Tareas manuales" contiene información general sobre las tareas que GitHub Actions Importer no puede completar automáticamente y que debes completar manualmente.

A continuación se incluyen algunos términos clave que pueden aparecer en la sección "Tareas manuales":

• Un secreto es un secreto de nivel de repositorio u organización que se usa en las canalizaciones convertidas. Estos secretos deben crearse manualmente en GitHub Actions para que estas canalizaciones funcionen correctamente. Para más información, consulta Using secrets in GitHub Actions.
• Un ejecutor autohospedado hace referencia a una etiqueta de un ejecutor al que se hace referencia en una canalización convertida que no es un ejecutor hospedado por GitHub. Tendrás que definir manualmente estos ejecutores para que estas canalizaciones funcionen correctamente.

Archivos

La sección final del informe de auditoría proporciona un manifiesto de todos los archivos que se escribieron en el disco durante la auditoría.

Cada archivo de canalización tiene varios archivos incluidos en la auditoría, entre los que se incluyen:

• La canalización original tal como se definió en GitHub.
• Las respuestas de red usadas para convertir la canalización.
• El archivo del flujo de trabajo convertido.
• Los seguimientos de pila que se pueden usar para solucionar problemas de una conversión de canalización con errores.

Además, el archivo workflow_usage.csv contiene una lista separada por comas de todas las acciones, los secretos y los ejecutores que usa cada una de las canalizaciones convertidas correctamente. Esto puede ser útil para determinar qué flujos de trabajo usan qué acciones, secretos o ejecutores, así como para realizar revisiones de seguridad.

Forecast potential GitHub Actions usage

You can use the forecast command to forecast potential GitHub Actions usage by computing metrics from completed pipeline runs in Azure DevOps.

Running the forecast command

To perform a forecast of potential GitHub Actions usage, run the following command in your terminal. By default, GitHub Actions Importer includes the previous seven days in the forecast report.

gh actions-importer forecast azure-devops --output-dir tmp/forecast_reports

Inspecting the forecast report

The forecast_report.md file in the specified output directory contains the results of the forecast.

Listed below are some key terms that can appear in the forecast report:

• The job count is the total number of completed jobs.

• The pipeline count is the number of unique pipelines used.

• Execution time describes the amount of time a runner spent on a job. This metric can be used to help plan for the cost of GitHub-hosted runners.

  This metric is correlated to how much you should expect to spend in GitHub Actions. This will vary depending on the hardware used for these minutes. You can use the GitHub Actions pricing calculator to estimate the costs.

• Queue time metrics describe the amount of time a job spent waiting for a runner to be available to execute it.

• Concurrent jobs metrics describe the amount of jobs running at any given time. This metric can be used to define the number of runners you should configure.

Additionally, these metrics are defined for each queue of runners in Azure DevOps. This is especially useful if there is a mix of hosted or self-hosted runners, or high or low spec machines, so you can see metrics specific to different types of runners.

Perform a dry-run migration

You can use the dry-run command to convert an Azure DevOps pipeline to an equivalent GitHub Actions workflow. A dry run creates the output files in a specified directory, but does not open a pull request to migrate the pipeline.

Si hay elementos que GitHub Actions Importer no pudo convertir automáticamente, como pasos de compilación desconocidos o una canalización parcialmente correcta, es posible que quieras crear transformadores personalizados para personalizar aún más el proceso de conversión. Para más información, consulta Extending GitHub Actions Importer with custom transformers.

Running the dry-run command for a build pipeline

To perform a dry run of migrating your Azure DevOps build pipeline to GitHub Actions, run the following command in your terminal, replacing pipeline_id with the ID of the pipeline you are converting.

gh actions-importer dry-run azure-devops pipeline --pipeline-id :pipeline_id --output-dir tmp/dry-run

You can view the logs of the dry run and the converted workflow files in the specified output directory.

Running the dry-run command for a release pipeline

To perform a dry run of migrating your Azure DevOps release pipeline to GitHub Actions, run the following command in your terminal, replacing pipeline_id with the ID of the pipeline you are converting.

gh actions-importer dry-run azure-devops release --pipeline-id :pipeline_id --output-dir tmp/dry-run

You can view the logs of the dry run and the converted workflow files in the specified output directory.

Perform a production migration

You can use the migrate command to convert an Azure DevOps pipeline and open a pull request with the equivalent GitHub Actions workflow.

Running the migrate command for a build pipeline

To migrate an Azure DevOps build pipeline to GitHub Actions, run the following command in your terminal, replacing the target-url value with the URL for your GitHub repository, and pipeline_id with the ID of the pipeline you are converting.

gh actions-importer migrate azure-devops pipeline --pipeline-id :pipeline_id --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate

The command's output includes the URL of the pull request that adds the converted workflow to your repository. An example of a successful output is similar to the following:

$ gh actions-importer migrate azure-devops pipeline --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --azure-devops-project my-azure-devops-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'

Running the migrate command for a release pipeline

To migrate an Azure DevOps release pipeline to GitHub Actions, run the following command in your terminal, replacing the target-url value with the URL for your GitHub repository, and pipeline_id with the ID of the pipeline you are converting.

gh actions-importer migrate azure-devops release --pipeline-id :pipeline_id --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate

The command's output includes the URL of the pull request that adds the converted workflow to your repository. An example of a successful output is similar to the following:

$ gh actions-importer migrate azure-devops release --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --azure-devops-project my-azure-devops-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'

Inspección de la solicitud de incorporación de cambios

La salida de una ejecución correcta del comando migrate contiene un vínculo a la nueva solicitud de incorporación de cambios que agrega el flujo de trabajo convertido al repositorio.

Entre algunos elementos importantes de la solicitud de incorporación de cambios se incluyen los siguientes:

• En la descripción de la solicitud de incorporación de cambios, una sección denominada Pasos manuales, que enumera los pasos que debes completar manualmente para poder finalizar la migración de las canalizaciones a GitHub Actions. Por ejemplo, esta sección puede indicarte que crees los secretos usados en los flujos de trabajo.
• El archivo de flujos de trabajo convertidos. Selecciona la pestaña Archivos cambiados de la solicitud de incorporación de cambios para ver el archivo de flujo de trabajo que se agregará al repositorio de GitHub.

Cuando hayas terminado de inspeccionar la solicitud de incorporación de cambios, puedes combinarla para agregar el flujo de trabajo al repositorio de GitHub.

Reference

This section contains reference information on environment variables, optional arguments, and supported syntax when using GitHub Actions Importer to migrate from Azure DevOps.

Configuration environment variables

GitHub Actions Importer usa variables de entorno para su configuración de autenticación. Estas variables se establecen al seguir el proceso de configuración mediante el comando configure. Para más información, consulta la sección Configuración de credenciales.

GitHub Actions Importer uses the following environment variables to connect to your Azure DevOps instance:

• GITHUB_ACCESS_TOKEN: The personal access token (classic) used to create pull requests with a converted workflow (requires the workflow scope).
• GITHUB_INSTANCE_URL: The URL to the target GitHub instance (for example, https://github.com).
• AZURE_DEVOPS_ACCESS_TOKEN: The personal access token used to authenticate with your Azure DevOps instance. This token requires the following scopes:
  • Build: Read
  • Agent Pools: Read
  • Code: Read
  • Release: Read
  • Service Connections: Read
  • Task Groups: Read
  • Variable Groups: Read
• AZURE_DEVOPS_PROJECT: The project name or GUID to use when migrating a pipeline. If you'd like to perform an audit on all projects, this is optional.
• AZURE_DEVOPS_ORGANIZATION: The organization name of your Azure DevOps instance.
• AZURE_DEVOPS_INSTANCE_URL: The URL to the Azure DevOps instance, such as https://dev.azure.com.

These environment variables can be specified in a .env.local file that is loaded by GitHub Actions Importer when it is run.

Optional arguments

Hay argumentos opcionales que puedes usar con los subcomandos de GitHub Actions Importer para personalizar la migración.

--source-file-path

You can use the --source-file-path argument with the forecast, dry-run, or migrate subcommands.

By default, GitHub Actions Importer fetches pipeline contents from source control. The --source-file-path argument tells GitHub Actions Importer to use the specified source file path instead.

For example:

gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --source-file-path ./path/to/azure_devops/pipeline.yml

--config-file-path

You can use the --config-file-path argument with the audit, dry-run, and migrate subcommands.

By default, GitHub Actions Importer fetches pipeline contents from source control. The --config-file-path argument tells GitHub Actions Importer to use the specified source files instead.

The --config-file-path argument can also be used to specify which repository a converted reusable workflow or composite action should be migrated to.

Audit example

In this example, GitHub Actions Importer uses the specified YAML configuration file as the source file to perform an audit.

gh actions-importer audit azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml

To audit an Azure DevOps instance using a configuration file, the configuration file must be in the following format and each repository_slug must be unique:

source_files:
  - repository_slug: azdo-project/1
    path: file.yml
  - repository_slug: azdo-project/2
    paths: path.yml

You can generate the repository_slug for a pipeline by combining the Azure DevOps organization name, project name, and the pipeline ID. For example, my-organization-name/my-project-name/42.

Dry run example

In this example, GitHub Actions Importer uses the specified YAML configuration file as the source file to perform a dry run.

The pipeline is selected by matching the repository_slug in the configuration file to the value of the --azure-devops-organization and --azure-devops-project option. The path is then used to pull the specified source file.

gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml

Specify the repository of converted reusable workflows and composite actions

GitHub Actions Importer uses the YAML file provided to the --config-file-path argument to determine the repository that converted reusable workflows and composite actions are migrated to.

To begin, you should run an audit without the --config-file-path argument:

gh actions-importer audit azure-devops --output-dir ./output/

The output of this command will contain a file named config.yml that contains a list of all the reusable workflows and composite actions that were converted by GitHub Actions Importer. For example, the config.yml file may have the following contents:

reusable_workflows:
  - name: my-reusable-workflow.yml
    target_url: https://github.com/octo-org/octo-repo
    ref: main

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

You can use this file to specify which repository and ref a reusable workflow or composite action should be added to. You can then use the --config-file-path argument to provide the config.yml file to GitHub Actions Importer. For example, you can use this file when running a migrate command to open a pull request for each unique repository defined in the config file:

gh actions-importer migrate azure-devops pipeline --config-file-path config.yml --target-url https://github.com/my-org/my-repo

Supported syntax for Azure DevOps pipelines

The following table shows the type of properties that GitHub Actions Importer is currently able to convert.

Azure Pipelines	GitHub Actions	Status
condition	jobs.<job_id>.if jobs.<job_id>.steps[*].if	Supported
container	jobs.<job_id>.container jobs.<job_id>.name	Supported
continuousIntegration	on.<push>.<branches> on.<push>.<tags> on.<push>.paths	Supported
job	jobs.<job_id>	Supported
pullRequest	on.<pull_request>.<branches> on.<pull_request>.paths	Supported
stage	jobs	Supported
steps	jobs.<job_id>.steps	Supported
strategy	jobs.<job_id>.strategy.fail-fast jobs.<job_id>.strategy.max-parallel jobs.<job_id>.strategy.matrix	Supported
timeoutInMinutes	jobs.<job_id>.timeout-minutes	Supported
variables	env jobs.<job_id>.env jobs.<job_id>.steps.env	Supported
manual deployment	jobs.<job_id>.environment	Partially supported
pool	runners self hosted runners	Partially supported
services	jobs.<job_id>.services	Partially supported
strategy	jobs.<job_id>.strategy	Partially supported
triggers	on	Partially supported
pullRequest	on.<pull_request>.<tags>	Unsupported
schedules	on.schedule on.workflow_run	Unsupported
triggers	on.<event_name>.types	Unsupported

For more information about supported Azure DevOps tasks, see the github/gh-actions-importer repository.

Environment variable mapping

GitHub Actions Importer uses the mapping in the table below to convert default Azure DevOps environment variables to the closest equivalent in GitHub Actions.

Azure Pipelines	GitHub Actions
$(Agent.BuildDirectory)	${{ runner.workspace }}
$(Agent.HomeDirectory)	${{ env.HOME }}
$(Agent.JobName)	${{ github.job }}
$(Agent.OS)	${{ runner.os }}
$(Agent.ReleaseDirectory)	${{ github.workspace}}
$(Agent.RootDirectory)	${{ github.workspace }}
$(Agent.ToolsDirectory)	${{ runner.tool_cache }}
$(Agent.WorkFolder)	${{ github.workspace }}
$(Build.ArtifactStagingDirectory)	${{ runner.temp }}
$(Build.BinariesDirectory)	${{ github.workspace }}
$(Build.BuildId)	${{ github.run_id }}
$(Build.BuildNumber)	${{ github.run_number }}
$(Build.DefinitionId)	${{ github.workflow }}
$(Build.DefinitionName)	${{ github.workflow }}
$(Build.PullRequest.TargetBranch)	${{ github.base_ref }}
$(Build.PullRequest.TargetBranch.Name)	${{ github.base_ref }}
$(Build.QueuedBy)	${{ github.actor }}
$(Build.Reason)	${{ github.event_name }}
$(Build.Repository.LocalPath)	${{ github.workspace }}
$(Build.Repository.Name)	${{ github.repository }}
$(Build.Repository.Provider)	GitHub
$(Build.Repository.Uri)	${{ github.server.url }}/${{ github.repository }}
$(Build.RequestedFor)	${{ github.actor }}
$(Build.SourceBranch)	${{ github.ref }}
$(Build.SourceBranchName)	${{ github.ref }}
$(Build.SourceVersion)	${{ github.sha }}
$(Build.SourcesDirectory)	${{ github.workspace }}
$(Build.StagingDirectory)	${{ runner.temp }}
$(Pipeline.Workspace)	${{ runner.workspace }}
$(Release.DefinitionEnvironmentId)	${{ github.job }}
$(Release.DefinitionId)	${{ github.workflow }}
$(Release.DefinitionName)	${{ github.workflow }}
$(Release.Deployment.RequestedFor)	${{ github.actor }}
$(Release.DeploymentID)	${{ github.run_id }}
$(Release.EnvironmentId)	${{ github.job }}
$(Release.EnvironmentName)	${{ github.job }}
$(Release.Reason)	${{ github.event_name }}
$(Release.RequestedFor)	${{ github.actor }}
$(System.ArtifactsDirectory)	${{ github.workspace }}
$(System.DefaultWorkingDirectory)	${{ github.workspace }}
$(System.HostType)	build
$(System.JobId)	${{ github.job }}
$(System.JobName)	${{ github.job }}
$(System.PullRequest.PullRequestId)	${{ github.event.number }}
$(System.PullRequest.PullRequestNumber)	${{ github.event.number }}
$(System.PullRequest.SourceBranch)	${{ github.ref }}
$(System.PullRequest.SourceRepositoryUri)	${{ github.server.url }}/${{ github.repository }}
$(System.PullRequest.TargetBranch)	${{ github.event.base.ref }}
$(System.PullRequest.TargetBranchName)	${{ github.event.base.ref }}
$(System.StageAttempt)	${{ github.run_number }}
$(System.TeamFoundationCollectionUri)	${{ github.server.url }}/${{ github.repository }}
$(System.WorkFolder)	${{ github.workspace }}

Templates

You can transform Azure DevOps templates with GitHub Actions Importer.

Limitations

GitHub Actions Importer is able to transform Azure DevOps templates with some limitations.

• Azure DevOps templates used under the stages, deployments, and jobs keys are converted into reusable workflows in GitHub Actions. For more information, see Reusing workflows.
• Azure DevOps templates used under the steps key are converted into composite actions. For more information, see Creating a composite action.
• If you currently have job templates that reference other job templates, GitHub Actions Importer converts the templates into reusable workflows. Because reusable workflows cannot reference other reusable workflows, this is invalid syntax in GitHub Actions. You must manually correct nested reusable workflows.
• If a template references an external Azure DevOps organization or GitHub repository, you must use the --credentials-file option to provide credentials to access this template. For more information, see Configuración y argumentos complementarios.
• You can dynamically generate YAML using each expressions with the following caveats:
  • Nested each blocks are not supported and cause the parent each block to be unsupported.
  • each and contained if conditions are evaluated at transformation time, because GitHub Actions does not support this style of insertion.
  • elseif blocks are unsupported. If this functionality is required, you must manually correct them.
  • Nested if blocks are supported, but if/elseif/else blocks nested under an if condition are not.
  • if blocks that use predefined Azure DevOps variables are not supported.

Supported templates

GitHub Actions Importer supports the templates listed in the table below.

Azure Pipelines	GitHub Actions	Status
Extending from a template	Reusable workflow	Supported
Job templates	Reusable workflow	Supported
Stage templates	Reusable workflow	Supported
Step templates	Composite action	Supported
Task groups in classic editor	Varies	Supported
Templates in a different Azure DevOps organization, project, or repository	Varies	Supported
Templates in a GitHub repository	Varies	Supported
Variable templates	env	Supported
Conditional insertion	if conditions on job/steps	Partially supported
Iterative insertion	Not applicable	Partially supported
Templates with parameters	Varies	Partially supported

Template file path names

GitHub Actions Importer can extract templates with relative or dynamic file paths with variable, parameter, and iterative expressions in the file name. However, there must be a default value set.

Variable file path name example

# File: azure-pipelines.yml
variables:
- template: 'templates/vars.yml'

steps:
- template: "./templates/$"

# File: templates/vars.yml
variables:
  one: 'simple_step.yml'

Parameter file path name example

parameters:
- name: template
  type: string
  default: simple_step.yml

steps:
- template: "./templates/${{ parameters.template }}"

Iterative file path name example

parameters:
- name: steps
  type: object
  default:
  - build_step
  - release_step
steps:
- ${{ each step in parameters.steps }}:
    - template: "$-variables.yml"

Template parameters

GitHub Actions Importer supports the parameters listed in the table below.

Azure Pipelines	GitHub Actions	Status
string	inputs.string	Supported
number	inputs.number	Supported
boolean	inputs.boolean	Supported
object	inputs.string with fromJSON expression	Partially supported
step	step	Partially supported
stepList	step	Partially supported
job	job	Partially supported
jobList	job	Partially supported
deployment	job	Partially supported
deploymentList	job	Partially supported
stage	job	Partially supported
stageList	job	Partially supported

Legal notice

Algunas partes se han adaptado a partir de https://github.com/github/gh-actions-importer/ con licencia 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.