Como migrar do CircleCI com o GitHub Actions Importer

Aviso legal

Sobre a migração do CircleCI 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 CircleCI para o GitHub Actions.

Pré-requisitos

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

• Acesso para criar um token de API pessoal do CircleCI para sua conta ou sua organização.

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

  • O Docker está instalado e em execução.
  • A CLI do GitHub está instalada.

  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 CircleCI para o GitHub Actions com o GitHub Actions Importer:

• Não há suporte para o cache automático entre trabalhos de fluxos de trabalho diferentes.
• O comando audit só é suportado quando você usa uma conta de organização CircleCI. Os comandos dry-run e migrate podem ser usados com uma conta de usuário ou de organização.

Tarefas manuais

Alguns constructos do CircleCI precisam ser migrados manualmente. Estão incluídos:

• Contextos
• Variáveis de ambiente de nível do projeto
• Propriedades de trabalho desconhecidas
• Orbs desconhecidos

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 opções obrigatórias para o GitHub Actions Importer ao trabalhar com o CircleCI e o GitHub.

1. Crie um GitHub personal access token (classic). 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 token de API pessoal do CircleCI. Para obter mais informações, confira Como gerenciar tokens de API na documentação do CircleCI.

   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 CircleCI, 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 o CircleCI", insira o valor do token de API pessoal do CircleCI criado anteriormente e pressione ENTER.
   • Em "URL base da instância do CircleCI", pressione ENTER para aceitar o valor padrão (https://circleci.com).
   • Em "Nome da organização do CircleCI", insira o nome da sua organização do CircleCI e pressione ENTER.

   Um exemplo do comando configure é mostrado abaixo:

   $ gh actions-importer configure
   ✔ Which CI providers are you configuring?: CircleCI
   Enter the following values (leave empty to omit):
   ✔ Personal access token for GitHub: ***************
   ✔ Base url of the GitHub instance: https://github.com
   ✔ Personal access token for CircleCI: ********************
   ✔ Base url of the CircleCI instance: https://circleci.com
   ✔ CircleCI organization name: mycircleciorganization
   Environment variables successfully updated.
   

4. No terminal, execute o comando update da CLI do GitHub Actions Importer para se conectar ao GitHub Packages Container registry e verificar se a imagem do contêiner foi atualizada para a última versão:

   gh actions-importer update
   

   A saída do comando será parecida com a mostrada abaixo:

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

Executar uma auditoria do CircleCI

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

O comando audit executa as seguintes etapas:

1. Busca todos os projetos definidos em uma organização do CircleCI.
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 CircleCI, execute o seguinte comando no terminal:

gh actions-importer audit circle-ci --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 CircleCI.

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 circle-ci --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. Essa métrica pode ser usada 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 no CircleCI. Isso é especialmente útil se há uma combinação de executores hospedados ou auto-hospedados, ou computadores de especificação alta ou baixa, de modo que você possa ver métricas específicas para diferentes tipos de executores.

Executar uma migração de simulação de um pipeline do CircleCI

Use o comando dry-run para converter um pipeline do CircleCI 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.

Para executar uma simulação de migração do seu projeto do CircleCI para o GitHub Actions, execute o comando a seguir no terminal, substituindo my-circle-ci-project pelo nome do projeto do CircleCI.

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

Você pode ver os logs da simulação e os arquivos de fluxo de trabalho convertidos no diretório de saída especificado.

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

Executar uma migração de produção de um pipeline do CircleCI

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

Como executar o comando de migração

Para migrar um pipeline do CircleCI para o GitHub Actions, execute o comando a seguir no terminal, substituindo o valor target-url pela URL do repositório GitHub e my-circle-ci-project pelo nome do projeto do CircleCI.

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

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

$ gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'

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 sintaxe com suporte ao usar o GitHub Actions Importer para a migração do CircleCI.

Usando variáveis de ambiente

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 CircleCI:

• GITHUB_ACCESS_TOKEN: o personal access token (classic) usado para criar solicitações de pull com um fluxo de trabalho convertido (exige os escopos repo e workflow).
• GITHUB_INSTANCE_URL: a URL para a instância de destino do GitHub (por exemplo, https://github.com).
• CIRCLE_CI_ACCESS_TOKEN: o token de API pessoal do CircleCI usado para se autenticar com a sua instância do CircleCI.
• CIRCLE_CI_INSTANCE_URL: a URL da instância do CircleCI (por exemplo, https://circleci.com). Se a variável for deixada sem definição, https://circleci.com será usado como o valor padrão.
• CIRCLE_CI_ORGANIZATION: o nome da organização da instância do CircleCI.
• CIRCLE_CI_PROVIDER: o local em que o arquivo de origem do pipeline é armazenado (como github). Atualmente, só há suporte para o GitHub.
• CIRCLE_CI_SOURCE_GITHUB_ACCESS_TOKEN (Opcional): o personal access token (classic) usado para se autenticar com a instância de origem do GitHub (exige o escopo repo). Se ele não for fornecido, o valor de GITHUB_ACCESS_TOKEN será usado.
• CIRCLE_CI_SOURCE_GITHUB_INSTANCE_URL (Opcional): a URL da instância de origem do GitHub. Se ele não for fornecido, o valor de GITHUB_INSTANCE_URL será usado.

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

Caso você deseje fornecer vários arquivos de origem ao executar o subcomando forecast, use padrões correspondentes no valor do caminho do arquivo. Por exemplo, o gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json fornece ao GitHub Actions Importer todos os arquivos de origem que correspondem ao caminho do arquivo ./tmp/previous_forecast/jobs/*.json.

--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 uma ação composta convertida deve ser migrada.

Exemplo de auditoria

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

gh actions-importer audit circle-ci --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml

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

source_files:
  - repository_slug: circle-org-name/circle-project-name
    path: path/to/.circleci/config.yml
  - repository_slug: circle-org-name/some-other-circle-project-name
    path: path/to/.circleci/config.yml

Exemplo de simulação

Neste exemplo, o GitHub Actions Importer usa a configuração YAML especificada 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 --circle-ci-organization e --circle-ci-project. Em seguida, o path é usado para efetuar pull do arquivo de origem especificado.

gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml

Especificar o repositório de ações compostas convertidas

GitHub Actions Importer usa o arquivo YAML fornecido ao argumento --config-file-path para determinar o repositório para o qual as ações compostas convertidas são migrados.

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

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

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

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 circle-ci --circle-ci-project my-project-name --output-dir output/ --config-file-path config.yml --target-url https://github.com/my-org/my-repo

--include-from

Use o argumento --include-from com o subcomando audit.

O argumento --include-from especifica um arquivo que contém uma lista delimitada por linhas de repositórios a serem incluídos na auditoria de uma organização do CircleCI. Todos os repositórios que não estão incluídos no arquivo são excluídos da auditoria.

Por exemplo:

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

O arquivo fornecido para esse parâmetro precisa ser uma lista de repositórios delimitada por linhas, por exemplo:

repository_one
repository_two
repository_three

Sintaxe com suporte para pipelines do CircleCI

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

Pipelines do CircleCI	GitHub Actions	Status
gatilhos cron	on.schedule	Com suporte
environment	env jobs.<job_id>.env jobs.<job_id>.steps.env	Com suporte
executors	runs-on	Com suporte
jobs	jobs	Com suporte
trabalho	jobs.<job_id> jobs.<job_id>.name	Com suporte
matriz	jobs.<job_id>.strategy jobs.<job_id>.strategy.matrix	Com suporte
parâmetros	env workflow-dispatch.inputs	Com suporte
etapas	jobs.<job_id>.steps	Com suporte
quando, a menos que	jobs.<job_id>.if	Com suporte
gatilhos	on	Com suporte
executors	container services	Com suporte parcial
orbs	actions	Com suporte parcial
executors	self hosted runners	Sem suporte
instalação	Não aplicável	Sem suporte
version	Não aplicável	Sem suporte

Para obter mais informações sobre o conceito do CircleCI e os mapeamentos de orb com suporte, 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 variáveis de ambiente padrão do CircleCI no equivalente mais próximo do GitHub Actions.

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

Aviso legal

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.