Migrando do Bitbucket Pipelines com o GitHub Actions Importer

Aviso legal

Sobre a migração do Bitbucket Pipelines com o GitHub Actions Importer

As instruções abaixo o guiarão na configuração do seu ambiente para usar o GitHub Actions Importer para migrar o Bitbucket Pipelines para o GitHub Actions.

Pré-requisitos

• 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 ao migrar do Bitbucket Pipelines para o GitHub Actions com o GitHub Actions Importer.

• Não há suporte para imagens em um AWS ECR privado.

• Não há suporte para a opção do Bitbucket Pipelines size.

• As métricas que detalham o tempo de fila dos trabalhos não são compatíveis com o comando forecast.

• Os scripts posteriores do Bitbucket são compatíveis com o uso do GitHub Actions always() em combinação com a verificação do steps.<step_id>.conclusion da etapa anterior. Para obter mais informações, confira "Acessar informações contextuais sobre execuções de fluxo de trabalho".

  Veja a seguir um exemplo de uso do always() com o steps.<step_id>.conclusion.

    - name: After Script 1
      run: |-
        echo "I'm after the script ran!"
        echo "We should be grouped!"
      id: after-script-1
      if: "${{ always() }}"
    - name: After Script 2
      run: |-
        echo "this is really the end"
        echo "goodbye, for now!"
      id: after-script-2
      if: "${{ steps.after-script-1.conclusion == 'success' && always() }}"
  

Tarefas manuais

Certos constructos do Bitbucket Pipelines devem ser migrados manualmente. Estão incluídos:

• Repositório seguro, espaço de trabalho e variáveis de implementação
• Chaves SSH

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 da CLI configure é usado para definir as credenciais e opções necessárias para o GitHub Actions Importer ao trabalhar com o Bitbucket Pipelines 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 acesso ao espaço de trabalho para o Bitbucket Pipelines. Para obter mais informações, consulte Permissões do token de acesso ao espaço de trabalho na documentação do Bitbucket. Seu token deve ter o escopo read para pipelines, projetos e repositórios.

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 Bitbucket, 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", pressione ENTER para aceitar o valor padrão (https://github.com).
   • Para "Personal access token para Bitbucket", digite o token de acesso ao espaço de trabalho que você criou anteriormente e pressione Enter.
   • Em "URL base da instância do Bitbucket", digite o URL da sua instância do Bitbucket e pressione Enter.

   Um exemplo do comando configure é mostrado abaixo:

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

Realizar uma auditoria da instância do Bitbucket

Você pode usar o comando audit para obter uma visão de alto nível dos pipelines em uma instância do Bitbucket.

O comando audit executa as seguintes etapas.

1. Obtém todos os pipelines de um espaço de trabalho.
2. Converte o pipeline em seu fluxo de trabalho equivalente ao 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 realizar uma auditoria, execute o seguinte comando em seu terminal, substituindo :workspace pelo nome do espaço de trabalho do Bitbucket a ser auditado.

gh actions-importer audit bitbucket --workspace :workspace --output-dir tmp/audit

Opcionalmente, uma opção --project-key pode ser fornecida ao comando audit para limitar os resultados apenas aos pipelines associados a um projeto.

No exemplo de comando abaixo, :project_key deve ser substituído pela chave do projeto que deve ser auditado. As chaves do projeto podem ser encontradas no Bitbucket na página de projetos do espaço de trabalho.

gh actions-importer audit bitbucket --workspace :workspace --project-key :project_key --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.

Previsão de uso

Você pode usar o comando forecast para prever o uso potencial de GitHub Actions, calculando métricas de execuções de pipeline concluídas na sua instância do Bitbucket.

Como executar o comando de previsão

Para realizar uma previsão do uso potencial do GitHub Actions, execute o seguinte comando em seu terminal, substituindo :workspace pelo nome do espaço de trabalho do Bitbucket a ser previsto. Por padrão, o GitHub Actions Importer inclui os sete dias anteriores no relatório de previsão.

gh actions-importer forecast bitbucket --workspace :workspace --output-dir tmp/forecast_reports

Previsão de um projeto

Para limitar a previsão a um projeto, você pode usar a opção --project-key. Substitua o valor do :project_key pela chave do projeto a ser previsto.

gh actions-importer forecast bitbucket --workspace :workspace --project-key :project_key --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 trabalhos simultâneos descrevem a quantidade de trabalhos em execução a qualquer momento.

Realização de uma migração simulada

Você pode usar o comando dry-run para converter um pipeline do Bitbucket 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.

Como executar o comando de simulação

Para executar um teste de migração de um pipeline do Bitbucket para o GitHub Actions, execute o seguinte comando em seu terminal, substituindo :workspace pelo nome do espaço de trabalho e :repo pelo nome do repositório no Bitbucket.

gh actions-importer dry-run bitbucket --workspace :workspace --repository :repo --output-dir tmp/dry-run

Como inspecionar os fluxos de trabalho convertidos

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

Realização de uma migração de produção

Você pode usar o comando migrate para converter um pipeline do Bitbucket e abrir uma solicitação de pull com o(s) fluxo(s) de trabalho equivalente(s) do GitHub Actions.

Como executar o comando de migração

Para migrar um pipeline do Bitbucket para o GitHub Actions, execute o seguinte comando no seu terminal, substituindo os seguintes valores.

• Substitua o valor target-url pelo URL do seu repositório GitHub.
• Substitua :repo pelo nome do repositório no Bitbucket.
• Substitua :workspace pelo nome do espaço de trabalho.

gh actions-importer migrate bitbucket --workspace :workspace --repository :repo --target-url https://github.com/:owner/:repo --output-dir tmp/dry-run

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 bitbucket --workspace actions-importer --repository custom-trigger --target-url https://github.com/valet-dev-testing/demo-private --output-dir tmp/bitbucket
[2023-07-18 09:56:06] Logs: 'tmp/bitbucket/log/valet-20230718-165606.log'
[2023-07-18 09:56:24] Pull request: 'https://github.com/valet-dev-testing/demo-private/pull/55'

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

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

Referência

Esta seção contém informações de referência sobre variáveis de ambiente, argumentos opcionais e sintaxe compatível ao usar o GitHub Actions Importer para migrar do Bitbucket Pipelines.

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 à sua instância do Bitbucket.

• GITHUB_ACCESS_TOKEN: o personal access token (classic) usado para criar solicitações pull com um fluxo de trabalho transformado (requer os escopos repo e workflow).
• GITHUB_INSTANCE_URL: a URL da instância de destino do GitHub. (por exemplo, https://github.com)
• BITBUCKET_ACCESS_TOKEN: token de acesso ao espaço de trabalho com escopos de leitura para pipeline, projeto e repositório.

Essas variáveis de ambiente podem ser especificadas em um arquivo .env.local que será carregado pelo GitHub Actions Importer em tempo de execução. O arquivo de distribuição contém um arquivo .env.local.template que pode ser usado para criar esses arquivos.

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 dry-run ou migrate.

Por padrão, o GitHub Actions Importer obtém o conteúdo do pipeline da instância do Bitbucket. 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 bitbucket --workspace :workspace --repository :repo --output-dir tmp/dry-run --source-file-path path/to/my/pipeline/file.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 obtém o conteúdo do pipeline da instância do Bitbucket. O argumento --config-file-path instrui o GitHub Actions Importer a usar o caminho dos arquivos de origem especificados.

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 bitbucket --workspace :workspace --output-dir tmp/audit --config-file-path "path/to/my/bitbucket/config.yml"

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

source_files:
  - repository_slug: repo_name
    path: path/to/one/source/file.yml
  - repository_slug: another_repo_name
    path: path/to/another/source/file.yml

Sintaxe compatível com o Bitbucket Pipelines

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

Bitbucket	GitHub Actions	Status
after-script	jobs.<job_id>.steps[*]	Com suporte
artifacts	actions/upload-artifact & download-artifact	Compatível
caches	actions/cache	Compatível
clone	actions/checkout	Compatível
condition	job.<job_id>.steps[*].run	Compatível
deployment	jobs.<job_id>.environment	Compatível
image	jobs.<job_id>.container	Compatível
max-time	jobs.<job_id>.steps[*].timeout-minutes	Com suporte
options.docker	Nenhum	Com suporte
options.max-time	jobs.<job_id>.steps[*].timeout-minutes	Compatível
parallel	jobs.<job_id>	Compatível
pipelines.branches	on.push	Compatível
pipelines.custom	on.workflow_dispatch	Compatível
pipelines.default	on.push	Compatível
pipelines.pull-requests	on.pull_requests	Compatível
pipelines.tags	on.tags	Compatível
runs-on	jobs.<job_id>.runs-on	Compatível
script	job.<job_id>.steps[*].run	Compatível
services	jobs.<job_id>.service	Compatível
stage	jobs.<job_id>	Compatível
step	jobs.<job_id>.steps[*]	Compatível
trigger	on.workflow_dispatch	Com suporte
fail-fast	Nenhum	Sem suporte
oidc	Nenhum	Sem suporte
options.size	Nenhum	Sem suporte
size	Nenhum	Sem suporte

Mapeamento de variáveis de ambiente

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

Bitbucket	GitHub Actions
CI	true
BITBUCKET_BUILD_NUMBER	${{ github.run_number }}
BITBUCKET_CLONE_DIR	${{ github.workspace }}
BITBUCKET_COMMIT	${{ github.sha }}
BITBUCKET_WORKSPACE	${{ github.repository_owner }}
BITBUCKET_REPO_SLUG	${{ github.repository }}
BITBUCKET_REPO_UUID	${{ github.repository_id }}
BITBUCKET_REPO_FULL_NAME	${{ github.repository_owner }}/${{ github.repository }}
BITBUCKET_BRANCH	${{ github.ref }}
BITBUCKET_TAG	${{ github.ref }}
BITBUCKET_PR_ID	${{ github.event.pull_request.number }}
BITBUCKET_PR_DESTINATION_BRANCH	${{ github.event.pull_request.base.ref }}
BITBUCKET_GIT_HTTP_ORIGIN	${{ github.event.repository.clone_url }}
BITBUCKET_GIT_SSH_ORIGIN	${{ github.event.repository.ssh_url }}
BITBUCKET_EXIT_CODE	${{ job.status }}
BITBUCKET_STEP_UUID	${{ job.github_job }}
BITBUCKET_PIPELINE_UUID	${{ github.workflow }}
BITBUCKET_PROJECT_KEY	${{ github.repository_owner }}
BITBUCKET_PROJECT_UUID	${{ github.repository_owner }}
BITBUCKET_STEP_TRIGGERER_UUID	${{ github.actor_id }}
BITBUCKET_SSH_KEY_FILE	${{ github.workspace }}/.ssh/id_rsa
BITBUCKET_STEP_OIDC_TOKEN	Sem mapeamento
BITBUCKET_DEPLOYMENT_ENVIRONMENT	Sem mapeamento
BITBUCKET_DEPLOYMENT_ENVIRONMENT_UUID	Sem mapeamento
BITBUCKET_BOOKMARK	Sem mapeamento
BITBUCKET_PARALLEL_STEP	Sem mapeamento
BITBUCKET_PARALLEL_STEP_COUNT	Sem mapeamento

Variáveis do sistema

As variáveis do sistema usadas em tarefas são transformadas na variável de shell de bash equivalente e são consideradas disponíveis. Por exemplo, ${system.<variable.name>} será transformado em $variable_name. Recomendamos que você verifique isso para garantir a operação adequada do fluxo de trabalho.

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.