Como migrar do Azure DevOps com o GitHub Actions Importer

Saiba como usar o GitHub Actions Importer para automatizar a migração dos pipelines do Azure DevOps para o GitHub Actions.

Neste artigo

Aviso legal

Sobre a migração do Azure DevOps com o GitHub Actions Importer

As instruções abaixo orientarão você na configuração do ambiente para usar o GitHub Actions Importer para migrar os pipelines do Azure DevOps para o GitHub Actions.

Pré-requisitos

  • Uma conta ou uma organização do Azure DevOps com projetos e pipelines que você deseja converter em fluxos de trabalho do GitHub Actions.

  • Acesso para criar um personal access token do Azure DevOps para sua conta ou organização.

  • Um ambiente em que seja possível executar contêineres baseados no Linux e instalar as ferramentas necessárias.

    Observação: a CLI e o contêiner do GitHub Actions Importer não precisam ser instalados no mesmo servidor que a plataforma de CI.

Limitações

Há algumas limitações na migração do Azure DevOps para o GitHub Actions com o GitHub Actions Importer:

  • O GitHub Actions Importer exige a versão 5.0 da API do Azure DevOps, disponível no Azure DevOps Services ou no Azure DevOps Server 2019. As versões mais antigas do Azure DevOps Server não são compatíveis.
  • As tarefas que são adicionadas implicitamente a um pipeline do Azure DevOps, como o check-out do código-fonte, podem ser adicionadas a uma auditoria do GitHub Actions Importer como um nome GUID. Para localizar o nome da tarefa amigável de um GUID, use a seguinte URL: https://dev.azure.com/:organization/_apis/distributedtask/tasks/:guid.

Tarefas manuais

Alguns constructos do Azure DevOps precisam ser migrados manualmente do Azure DevOps para as configurações do GitHub Actions. Estão incluídos:

  • Segredos de organização, repositório e ambiente
  • Conexões de serviço como o OIDC Connect, o GitHub Apps e os personal access tokens
  • Tarefas desconhecidas
  • Agentes auto-hospedados
  • Ambientes
  • Aprovações pré-implantação

Para saber mais sobre migrações manuais, confira "Migrar do Azure Pipelines para o GitHub Actions."

Tabelas sem suporte

O GitHub Actions Importer não dá suporte à migração das seguintes tarefas:

  • Portões pré-implantação
  • Portões pós-implantação
  • Aprovações pós-implantação
  • Alguns gatilhos de recurso

Instalação da extensão da CLI do GitHub Actions Importer

  1. Instale a extensão da CLI do GitHub Actions Importer:

    Bash
    gh extension install github/gh-actions-importer

  2. Verifique se a extensão foi 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.

Como configurar credenciais

O comando configure da CLI é usado para definir as credenciais e as opções obrigatórias para o GitHub Actions Importer ao trabalhar com o Azure DevOps e o GitHub.

  1. Crie um personal access token (classic) do GitHub. Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".

    O token precisa ter o escopo workflow.

    Depois de criar o token, copie-o e salve-o em um local seguro para uso posterior.

  2. Crie um personal access token do Azure DevOps. Para saber mais, confira Usar personal access tokens na documentação do Azure DevOps. O token precisa ter os seguintes escopos:

    • Pool de agentes: Read
    • Build: Read
    • Código: Read
    • Versão: Read
    • Conexões de serviço: Read
    • Grupos de tarefas: Read
    • Grupo de variáveis: Read

    Depois de criar o token, copie-o e salve-o em um local seguro para uso posterior.

  3. No terminal, execute o comando da CLI configure do GitHub Actions Importer:

    gh actions-importer configure

    O comando configure solicitará que você insira as seguintes informações:

    • Em "Quais provedores de CI você está configurando?", use as teclas de direção para selecionar Azure DevOps, pressione Espaço para fazer a seleção e pressione Enter.
    • Em "Personal access token para GitHub", insira o valor do personal access token (classic) criado anteriormente e pressione Enter.
    • Em "URL base da instância do GitHub", insira a URL da instância do GitHub Enterprise Server e pressione ENTER.
    • Em "Personal access token para Azure DevOps", insira o valor do personal access token do Azure DevOps criado anteriormente e pressione ENTER.
    • Em "URL base da instância do Azure DevOps", pressione ENTER para aceitar o valor padrão (https://dev.azure.com).
    • Em "Nome da organização do Azure DevOps", insira o nome da sua organização do Azure DevOps e pressione ENTER.
    • Em "Nome do projeto do Azure DevOps", insira o nome do projeto do Azure DevOps e pressione ENTER.

    Um exemplo do comando configure é mostrado abaixo:

    $ 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. No terminal, execute o comando update da CLI do GitHub Actions Importer para se conectar ao GitHub Packages Container registry e verifique se a imagem de contêiner foi atualizada para a última versão:

    gh actions-importer update

    A saída do comando será semelhante ao seguinte:

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

Executar uma auditoria do Azure DevOps

Use o comando audit para obter uma exibição de alto nível de todos os projetos de uma organização do Azure DevOps.

O comando audit executa as seguintes etapas:

  1. Busca todos os projetos definidos em uma organização do Azure DevOps.
  2. Converte cada pipeline no fluxo de trabalho equivalente do GitHub Actions.
  3. Gera um relatório que resume a possibilidade do nível de integridade e complexidade de uma migração com o GitHub Actions Importer.

Como executar o comando de auditoria

Para executar uma auditoria de uma organização do Azure DevOps, execute o seguinte comando no terminal:

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

Como inspecionar os resultados da auditoria

Os arquivos do diretório de saída especificado contêm os resultados da auditoria. Confira o arquivo audit_summary.md para ver um resumo dos resultados da auditoria.

O resumo da auditoria contém as seções a seguir.

Pipelines

A seção "Pipelines" contém estatísticas de alto nível sobre a taxa de conversão feita pelo GitHub Actions Importer.

Veja abaixo alguns termos importantes que podem aparecer na seção "Pipelines":

  • Os pipelines Bem-sucedidos tiveram 100% dos constructos e itens individuais convertidos automaticamente nos equivalentes do GitHub Actions.
  • Os pipelines parcialmente bem-sucedidos tiveram todos os constructos de pipeline convertidos, porém, houve alguns itens individuais que não foram convertidos automaticamente nos GitHub Actions equivalentes.
  • Os pipelines Sem suporte são tipos de definição que não têm suporte no GitHub Actions Importer.
  • Os pipelines com falha encontraram um erro fatal ao serem convertidos. Isso pode ocorrer por uma das seguintes razões:
    • O pipeline foi originalmente configurado de forma incorreta e inválida.
    • O GitHub Actions Importer encontrou um erro interno ao convertê-lo.
    • Houve uma resposta de rede malsucedida que tornou o pipeline inacessível, o que geralmente ocorre devido a credenciais inválidas.

Etapas de Build

A seção "Etapas de compilação" contém uma visão geral das etapas de compilação individuais usadas em todos os pipelines e indica quantas delas foram convertidas automaticamente pelo GitHub Actions Importer.

Veja abaixo alguns termos importantes que podem aparecer na seção "Etapas de compilação":

  • Uma etapa de compilação conhecida foi convertida automaticamente em uma ação equivalente.
  • Uma etapa de compilação desconhecida não foi convertida automaticamente em uma ação equivalente.
  • Uma etapa de compilação sem suporte é aquela que:
    • Fundamentalmente, não tem suporte no GitHub Actions.
    • Foi configurada de maneira incompatível com o GitHub Actions.
  • Uma ação é uma lista das ações que foram usadas nos fluxos de trabalho convertidos. Isso pode ser importante para:
    • Se você usar o GitHub Enterprise Server, reunir a lista de ações a serem sincronizadas com a sua instância.
    • Definir uma lista de permissões no nível da organização das ações que são usadas. Essa lista de ações é abrangente e inclui as ações que as equipes de segurança ou conformidade podem precisar analisar.

Tarefas manuais

A seção "Tarefas manuais" contém uma visão geral das tarefas que o GitHub Actions Importer não consegue executar automaticamente e que precisam ser realizadas de maneira manual.

Veja abaixo alguns termos importantes que podem aparecer na seção "Tarefas manuais":

  • Um segredo é um repositório ou um segredo no nível da organização que é usado nos pipelines convertidos. Esses segredos devem ser criados manualmente no GitHub Actions para que os pipelines funcionem de maneira correta. Para obter mais informações, confira "Usar segredos em ações do GitHub".
  • Um executor auto-hospedado refere-se a um rótulo de um executor que é referenciado em um pipeline convertido e que não é hospedado no GitHub. Será necessário definir manualmente esses executores para que os pipelines funcionem de maneira correta.

Arquivos

A seção final do relatório de auditoria fornece um manifesto de todos os arquivos que foram gravados em disco durante a auditoria.

Cada arquivo de pipeline tem uma variedade de arquivos contidos na auditoria, incluindo:

  • O pipeline original como foi definido no GitHub.
  • Todas as respostas de rede usadas para converter o pipeline.
  • O arquivo de fluxo de trabalho convertido.
  • Rastreamentos de pilha que podem ser usados para solucionar problemas de uma conversão de pipeline com falha.

Além disso, o arquivo workflow_usage.csv contém uma lista separada por vírgula de todas as ações, todos os segredos e todos os executores usados pelos pipelines convertidos com sucesso. Isso pode ser útil para determinar quais fluxos de trabalho usam quais ações, segredos ou executores e para executar revisões de segurança.

Prever o uso potencial do GitHub Actions

Use o comando forecast para prever o uso potencial do GitHub Actions calculando métricas de execuções de pipeline concluídas no Azure DevOps.

Como executar o comando de previsão

Para executar uma previsão do uso potencial do GitHub Actions, execute o comando a seguir no terminal. Por padrão, o GitHub Actions Importer inclui os sete dias anteriores no relatório de previsão.

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

Como inspecionar o relatório de previsão

O arquivo forecast_report.md no diretório de saída especificado contém os resultados da previsão.

Veja abaixo alguns termos importantes que podem aparecer no relatório de previsão:

  • A contagem de trabalhos é o número total de trabalhos concluídos.

  • A contagem de pipelines é o número de pipelines exclusivos usados.

  • O tempo de execução descreve o tempo gasto por um executor em um trabalho. Essa métrica pode ser usada para auxiliar no plano de custo dos executores hospedados pelo GitHub.

    Ela está correlacionada ao custo possível esperado com o GitHub Actions. Isso pode variar de acordo com o hardware usado para esses minutos. Use a calculadora de preços do GitHub Actions para estimar os custos.

  • As métricas de tempo de espera descrevem o tempo gasto por um trabalho aguardando um executor ficar disponível para executá-lo.

  • As métricas de trabalhos simultâneos descrevem a quantidade de trabalhos em execução a qualquer momento. Elas podem ser usadas para definir o número de executores que você deve configurar.

Além disso, essas métricas são definidas para cada fila de executores do Azure DevOps. Isso é especialmente útil quando há uma combinação de executores hospedados ou auto-hospedados ou quando há computadores de especificação alta ou baixa, a fim de ver métricas específicas para diferentes tipos de executores.

Realizar uma simulação de migração

Use o comando dry-run para converter um pipeline do Azure DevOps em um fluxo de trabalho equivalente do GitHub Actions. Uma simulação cria os arquivos de saída em um diretório especificado, mas não abre uma solicitação de pull para migrar o pipeline.

No caso de qualquer item que o GitHub Actions Importer não tenha conseguido converter automaticamente, como etapas de build desconhecidas ou um pipeline parcialmente bem-sucedido, o ideal é criar transformadores personalizados para personalizar ainda mais o processo de conversão. Para obter mais informações, confira "Como estender o Importador de GitHub Actions com transformadores personalizados".

Como executar o comando de simulação para um pipeline de build

Para executar uma simulação de migração do pipeline de build do Azure DevOps para o GitHub Actions, execute o comando a seguir no terminal, substituindo pipeline_id pela ID do pipeline que você está convertendo.

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

É possível ver os logs da simulação e os arquivos de fluxos de trabalho convertidos no diretório de saída especificado.

Como executar o comando de simulação para um pipeline de lançamento

Para executar uma simulação de migração dos pipelines do Azure DevOps para o GitHub Actions, execute o comando a seguir no terminal, substituindo pipeline_id pela ID do pipeline que você está convertendo.

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

É possível ver os logs da simulação e os arquivos de fluxos de trabalho convertidos no diretório de saída especificado.

Executar uma migração de produção

Use o comando migrate para converter um pipeline do Azure DevOps e abrir uma solicitação de pull com o fluxo de trabalho equivalente do GitHub Actions.

Como executar o comando de migração para um pipeline de build

Para migrar um pipeline de build do Azure DevOps para o GitHub Actions, execute o comando a seguir no terminal, substituindo o valor target-url pela URL do repositório GitHub e pipeline_id pela ID do pipeline que você está convertendo.

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

A saída do comando inclui a URL da solicitação de pull que adiciona o fluxo de trabalho convertido ao repositório. Um exemplo de uma saída bem-sucedida é semelhante ao seguinte:

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

Como executar o comando de migração para um pipeline de lançamento

Para migrar um pipeline de lançamento do Azure DevOps para o GitHub Actions, execute o comando a seguir no terminal, substituindo o valor target-url pela URL do repositório GitHub e pipeline_id pela ID do pipeline que você está convertendo.

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

A saída do comando inclui a URL da solicitação de pull que adiciona o fluxo de trabalho convertido ao repositório. Um exemplo de uma saída bem-sucedida é semelhante ao seguinte:

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

Como inspecionar a solicitação de pull

A saída de uma execução bem-sucedida do comando migrate contém um link para a nova solicitação de pull que adiciona o fluxo de trabalho convertido ao seu repositório.

Alguns elementos importantes da solicitação de pull incluem:

  • Na descrição da solicitação de pull, uma seção chamada Etapas manuais, que lista as etapas que você precisa concluir manualmente para concluir a migração dos pipelines para o GitHub Actions. Por exemplo, esta seção pode solicitar a criação dos segredos usados nos fluxos de trabalho.
  • O arquivo de fluxos de trabalho convertido. Selecione a guia Arquivos alterados na solicitação de pull para ver o arquivo de fluxo de trabalho que será adicionado ao repositório do GitHub Enterprise Server.

Quando terminar de inspecionar a solicitação de pull, mescle-a para adicionar o fluxo de trabalho ao repositório do GitHub Enterprise Server.

Referência

Esta seção contém informações de referência sobre variáveis de ambiente, argumentos opcionais e a sintaxe com suporte durante o uso do GitHub Actions Importer para migração do Azure DevOps.

Variáveis de ambiente da configuração

O GitHub Actions Importer usa variáveis de ambiente para a configuração de autenticação. Essas variáveis são definidas durante o processo de configuração com o comando configure. Para obter mais informações, confira a seção "Como configurar as credenciais".

O GitHub Actions Importer usa as seguintes variáveis de ambiente para se conectar à instância do Azure DevOps:

  • GITHUB_ACCESS_TOKEN: o personal access token (classic) usado para criar solicitações de pull com um fluxo de trabalho convertido (o escopo workflow é necessário).
  • GITHUB_INSTANCE_URL: a URL para a instância de destino do GitHub (por exemplo, https://github.com).
  • AZURE_DEVOPS_ACCESS_TOKEN: o personal access token usado para autenticação na sua instância do Azure DevOps. Esse token exige os seguintes escopos:
    • Build: Read
    • Pools de agentes: Read
    • Código: Read
    • Versão: Read
    • Conexões de serviço: Read
    • Grupos de tarefas: Read
    • Grupo de variáveis: Read
  • AZURE_DEVOPS_PROJECT: o nome do projeto ou o GUID a ser usado ao migrar um pipeline. Caso você deseje executar uma auditoria em todos os projetos, isso é opcional.
  • AZURE_DEVOPS_ORGANIZATION: o nome da organização da instância do Azure DevOps.
  • AZURE_DEVOPS_INSTANCE_URL: a URL para a instância do Azure DevOps, como https://dev.azure.com.

Essas variáveis de ambiente podem ser especificadas em um arquivo .env.local carregado pelo GitHub Actions Importer quando ele é executado.

Argumentos opcionais

Há argumentos opcionais que você pode usar com os subcomandos do GitHub Actions Importer para personalizar sua migração.

--source-file-path

Use o argumento --source-file-path com os subcomandos forecast, dry-run ou migrate.

Por padrão, o GitHub Actions Importer busca o conteúdo do pipeline no controle do código-fonte. O argumento --source-file-path instrui o GitHub Actions Importer a usar o caminho do arquivo de origem especificado.

Por exemplo:

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

--config-file-path

Use o argumento --config-file-path com os subcomandos audit, dry-run e migrate.

Por padrão, o GitHub Actions Importer busca o conteúdo do pipeline no controle do código-fonte. O argumento --config-file-path instrui o GitHub Actions Importer a usar o caminho dos arquivos de origem especificados.

O argumento --config-file-path também pode ser usado para especificar para qual repositório um fluxo de trabalho reutilizável convertido ou uma ação composta deve ser migrada.

Exemplo de auditoria

Neste exemplo, o GitHub Actions Importer usa o arquivo de configuração YAML especificado como o arquivo de origem para executar uma auditoria.

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

Para auditar uma instância do Azure DevOps usando um arquivo de configuração, o arquivo precisa estar no seguinte formato e cada repository_slug precisa ser exclusivo:

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

Você pode gerar o repository_slug para um pipeline combinando o nome da organização do Azure DevOps, o nome do projeto e a ID do pipeline. Por exemplo, my-organization-name/my-project-name/42.

Exemplo de simulação

Neste exemplo, o GitHub Actions Importer usa o arquivo de configuração YAML especificado como o arquivo de origem a fim de executar uma simulação.

O pipeline é selecionado pela correspondência do repository_slug no arquivo de configuração com o valor das opções --azure-devops-organization e --azure-devops-project. Em seguida, path é usado para efetuar pull do arquivo de origem especificado.

gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml
Especificar o repositório de fluxos de trabalho reutilizáveis convertidos e ações compostas

GitHub Actions Importer usa o arquivo YAML fornecido ao argumento --config-file-path para determinar o repositório para o qual os fluxos de trabalho reutilizáveis convertidos e as ações compostas são migrados.

Para começar, você deve executar uma auditoria sem o argumento --config-file-path:

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

A saída desse comando conterá um arquivo chamado config.yml que contém uma lista de todos os fluxos de trabalho reutilizáveis e ações compostas que foram convertidas por GitHub Actions Importer. Por exemplo, o arquivo config.yml pode ter o seguinte conteúdo:

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

Você pode usar esse arquivo para especificar a qual repositório e ref um fluxo de trabalho reutilizável ou uma ação composta deve ser adicionado. Em seguida, você pode usar o argumento --config-file-path para fornecer o arquivo config.yml para GitHub Actions Importer. Por exemplo, você pode usar esse arquivo ao executar um comando migrate para abrir uma solicitação de pull para cada repositório exclusivo definido no arquivo de configuração:

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

Sintaxe com suporte para pipelines do Azure DevOps

A tabela a seguir mostra os tipos de propriedades que o GitHub Actions Importer pode converter no momento.

Azure PipelinesGitHub ActionsStatus
condition
  • jobs.<job_id>.if
  • jobs.<job_id>.steps[*].if
Com suporte
contêiner
  • jobs.<job_id>.container
  • jobs.<job_id>.name
Com suporte
continuousIntegration
  • on.<push>.<branches>
  • on.<push>.<tags>
  • on.<push>.paths
Com suporte
trabalho
  • jobs.<job_id>
Com suporte
pullRequest
  • on.<pull_request>.<branches>
  • on.<pull_request>.paths
Com suporte
preparar
  • jobs
Com suporte
etapas
  • jobs.<job_id>.steps
Com suporte
estratégia
  • jobs.<job_id>.strategy.fail-fast
  • jobs.<job_id>.strategy.max-parallel
  • jobs.<job_id>.strategy.matrix
Com suporte
timeoutInMinutes
  • jobs.<job_id>.timeout-minutes
Com suporte
variáveis
  • env
  • jobs.<job_id>.env
  • jobs.<job_id>.steps.env
Com suporte
manual deployment
  • jobs.<job_id>.environment
Suporte parcial
pool
  • runners
  • self hosted runners
Suporte parcial
services
  • jobs.<job_id>.services
Suporte parcial
estratégia
  • jobs.<job_id>.strategy
Suporte parcial
gatilhos
  • on
Suporte parcial
pullRequest
  • on.<pull_request>.<tags>
Sem suporte
schedules
  • on.schedule
  • on.workflow_run
Sem suporte
gatilhos
  • on.<event_name>.types
Sem suporte

Para obter mais informações sobre as tarefas com suporte do Azure DevOps, confira o repositório github/gh-actions-importer.

Mapeamento de variáveis de ambiente

O GitHub Actions Importer usa o mapeamento da tabela abaixo para converter as variáveis de ambiente padrão do Azure DevOps no equivalente mais próximo do GitHub Actions.

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

Modelos

Você pode transformar os modelos do Azure DevOps com o GitHub Actions Importer.

Limitações

O GitHub Actions Importer pode transformar modelos do Azure DevOps com algumas limitações.

  • Os modelos do Azure DevOps usados nas chaves stages, deployments e jobs são convertidos em fluxos de trabalho reutilizáveis no GitHub Actions. Para obter mais informações, confira "Reutilizar fluxos de trabalho".
  • Os modelos do Azure DevOps usados na chave steps são convertidos em ações compostas. Para obter mais informações, confira "Criar uma ação composta".
  • Se você tiver modelos de trabalho que referenciam outros modelos de trabalho, i GitHub Actions Importer converterá os modelos em fluxos de trabalho reutilizáveis. Como os fluxos de trabalho reutilizáveis não podem referenciar outros fluxos de trabalho reutilizáveis, essa é uma sintaxe inválida no GitHub Actions. Você precisa corrigir manualmente os fluxos de trabalho aninhados reutilizáveis.
  • Se um modelo referencia uma organização externa do Azure DevOps ou um repositório GitHub, use a opção --credentials-file para fornecer credenciais para acessar esse modelo. Para obter mais informações, confira "Argumentos e configurações complementares".
  • Você pode gerar o YAML dinamicamente usando expressões each com as seguintes advertências:
    • Não há suporte para blocos each aninhados, e eles fazem com que o bloco pai each não tenha suporte.
    • As condições each e if contidas são avaliadas em tempo de transformação, pois o GitHub Actions não dá suporte a esse estilo de inserção.
    • Não há suporte para blocos elseif. Se essa funcionalidade for necessária, você precisará corrigi-las manualmente.
    • Há suporte para blocos if aninhados, mas não há suporte para blocos if/elseif/else aninhados em uma condição if.
    • Não há suporte para blocos if que usam variáveis predefinidas do Azure DevOps.

Modelos com suporte

O GitHub Actions Importer dá suporte aos modelos listados na tabela abaixo.

Azure PipelinesGitHub ActionsStatus
Extensão de um modeloReusable workflowCom suporte
Modelos de trabalhoReusable workflowCom suporte
Modelos de estágioReusable workflowCom suporte
Modelos de etapaComposite actionCom suporte
Grupos de tarefas no editor clássicoVariaCom suporte
Modelos em uma organização, um projeto ou um repositório diferentes do Azure DevOpsVariaCom suporte
Modelos em um repositório GitHubVariaCom suporte
Modelos de variávelenvCom suporte
Inserção condicionalCondições if no trabalho/nas etapasSuporte parcial
Inserção iterativaNão aplicávelSuporte parcial
Modelos com parâmetrosVariaSuporte parcial

Nomes de caminho de arquivo de modelo

O GitHub Actions Importer pode extrair modelos com caminhos de arquivo relativos ou dinâmicos com expressões de variáveis, de parâmetros e iterativas no nome do arquivo. No entanto, é preciso haver um conjunto de valores padrão.

Exemplo de nome do caminho de arquivo de variável
# File: azure-pipelines.yml
variables:
- template: 'templates/vars.yml'

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

# File: templates/vars.yml
variables:
  one: 'simple_step.yml'
Exemplo de nome do caminho de arquivo de parâmetro
parameters:
- name: template
  type: string
  default: simple_step.yml

steps:
- template: "./templates/${{ parameters.template }}"
Exemplo de nome do caminho de arquivo iterativo
parameters:
- name: steps
  type: object
  default:
  - build_step
  - release_step
steps:
- ${{ each step in parameters.steps }}:
    - template: "$-variables.yml"

Parâmetros de modelo

O GitHub Actions Importer dá suporte aos parâmetros listados na tabela abaixo.

Azure PipelinesGitHub ActionsStatus
stringinputs.stringCom suporte
númeroinputs.numberCom suporte
booleanoinputs.booleanCom suporte
objetoinputs.string com a expressão fromJSONSuporte parcial
EtapastepSuporte parcial
stepListstepSuporte parcial
trabalhojobSuporte parcial
jobListjobSuporte parcial
implantaçãojobSuporte parcial
deploymentListjobSuporte parcial
prepararjobSuporte parcial
stageListjobSuporte parcial

Note

Um modelo usado na chave step com esse tipo de parâmetro só será serializado como uma ação composta se as etapas forem usadas no início ou no final das etapas do modelo. Um modelo usado nas chaves stage, deployment e job com esse tipo de parâmetro não são transformados em um fluxo de trabalho reutilizável e são serializados como um fluxo de trabalho autônomo.

Partes foram adaptadas do https://github.com/github/gh-actions-importer/ de acordo com a licença 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.