# Migrando do Travis CI com GitHub Actions Importer Saiba como usar o GitHub Actions Importer para automatizar a migração dos pipelines do Travis CI para o GitHub Actions. ## Sobre a migração do Travis CI para o GitHub Actions usando o importador As instruções abaixo orientarão você na configuração do ambiente para usar o GitHub Actions Importer para migrar os pipelines do Travis CI para o GitHub Actions. ### Pré-requisitos * Uma conta ou uma organização do Travis CI com pipelines e trabalhos que você deseja converter em fluxos de trabalho do GitHub Actions. * Acesso para criar um token de acesso à API do Travis CI 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](https://docs.docker.com/get-docker/) e em execução. * A [CLI do GitHub](https://cli.github.com) está instalada. > \[!NOTE] > 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 dos pipelines do Travis CI para o GitHub Actions com o GitHub Actions Importer. #### Tarefas manuais Alguns constructos do Travis CI precisam ser migrados manualmente. Estão incluídos: * Segredos * Propriedades de trabalho desconhecidas Para saber mais sobre migrações manuais, confira [Migrando de Travis CI para GitHub Actions](/pt/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions). #### Linguagens do projeto do Travis CI O GitHub Actions Importer transforma as linguagens de projeto do Travis CI adicionando um conjunto de ferramentas de build configuradas previamente e um script de build padrão ao fluxo de trabalho transformado. Se nenhuma linguagem é declarada explicitamente, o GitHub Actions Importer pressupõe que a linguagem de projeto seja o Ruby. Para ver uma lista das linguagens de projeto com suporte no GitHub Actions Importer, confira [Linguagens de projeto com suporte](#supported-project-languages). ## Instalação da extensão da CLI do GitHub Actions Importer 1. Instale a extensão da CLI do GitHub Actions Importer: ```bash copy gh extension install github/gh-actions-importer ``` 2. Verifique se a extensão foi instalada: ```bash $ 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 Travis CI e o GitHub. 1. Crie um GitHub do personal access token (classic). Para saber mais, confira [Gerenciar seus tokens de acesso pessoal](/pt/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). 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 à API do Travis CI. Para obter mais informações, confira [Obter seu token de API do Travis CI](https://docs.travis-ci.com/user/migrate/travis-migrate-to-apps-gem-guide/#4-get-your-travis-ci-api-token) na documentação do Travis CI. 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: ```shell 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 `Travis CI`, pressione Espaço para fazer a seleção e pressione Enter. * Para "Personal access token para GitHub", insira o valor do personal access token (classic) que você criou anteriormente e pressione Enter. * Para "URL base da instância do GitHub", press Enter para aceitar o valor padrão (`https://github.com`).. * Em "Personal access token para o Travis CI", insira o valor do token de acesso à API do Travis CI criado anteriormente e pressione ENTER. * Em "URL base da instância do Travis CI", insira a URL da instância do Travis CI e pressione ENTER. * Em "Nome da organização do Travis CI", insira o nome da sua organização do Travis CI e pressione ENTER. Um exemplo da saída do comando `configure` é mostrado abaixo. ```shell $ gh actions-importer configure ✔ Which CI providers are you configuring?: Travis CI 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 Travis CI: *************** ✔ Base url of the Travis CI instance: https://travis-ci.com ✔ Travis CI organization name: actions-importer-labs 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: ```shell gh actions-importer update ``` A saída do comando será semelhante ao seguinte: ```shell Updating ghcr.io/actions-importer/cli:latest... ghcr.io/actions-importer/cli:latest up-to-date ``` ## Executar uma auditoria do Travis CI Use o comando `audit` para obter uma exibição de alto nível de todos os pipelines de um servidor do Travis CI. O comando `audit` executa as seguintes etapas: 1. Busca todos os projetos definidos em um servidor do Travis CI. 2. Converte cada pipeline no fluxo de trabalho equivalente do GitHub Actions. 3. Gera um relatório que resume o quão completa e complexa pode ser uma migração com o GitHub Actions Importer. ### Como executar o comando de auditoria Para executar uma auditoria de um servidor do Travis CI, execute o seguinte comando no terminal: ```shell gh actions-importer audit travis-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 saber mais, confira [Usar segredos em ações do GitHub](/pt/actions/security-guides/using-secrets-in-github-actions). * 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 executor de compilação Use o comando `forecast` para prever o uso potencial do GitHub Actions calculando as métricas das execuções de pipeline concluídas no servidor do Travis CI. ### 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. ```shell gh actions-importer forecast travis-ci --output-dir tmp/forecast ``` ### 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 a quantidade de tempo que um executor gastou na execução de uma tarefa. Essa métrica pode ser usada para auxiliar no plano de custo dos executores hospedados pelo GitHub. * Essa métrica está correlacionada a quanto você deve esperar gastar no GitHub Actions. Isso pode variar de acordo com o hardware usado para esses minutos. Você pode usar a [calculadora de preços do GitHub Actions](https://github.com/pricing/calculator) 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. Esta 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 runners no Travis CI. 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. ## Executar uma simulação de migração de um pipeline do Travis CI Use o comando `dry-run` para converter um pipeline do Travis CI 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 dos pipelines do Travis CI para o GitHub Actions, execute o comando a seguir no terminal, substituindo `my-travis-ci-repository` pelo nome do repositório do Travis CI. ```shell gh actions-importer dry-run travis-ci --travis-ci-repository my-travis-ci-repository --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. 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 saber mais, confira [Estendendo o Importador do GitHub Actions com transformadores personalizados](/pt/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers). ## Executar uma migração de produção de um pipeline do Travis CI Use o comando `migrate` para converter um pipeline do Travis CI 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 Travis CI para o GitHub Actions, execute o comando a seguir no terminal, substituindo o valor `target-url` pela URL do repositório GitHub e `my-travis-ci-repository` pelo nome do repositório do Travis CI. ```shell gh actions-importer migrate travis-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --travis-ci-repository my-travis-ci-repository ``` A saída do comando inclui a URL para a 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: ```shell $ gh actions-importer migrate travis-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --travis-ci-repository my-travis-ci-repository [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 **Files changed** na pull request para ver o arquivo de fluxo de trabalho que será adicionado ao repositório do GitHub. Quando terminar de inspecionar a pull request, você poderá mesclá-la para adicionar o fluxo de trabalho ao repositório do GitHub. ## Referência Esta seção contém informações de referência sobre as variáveis de ambiente, os argumentos opcionais e a sintaxe com suporte ao usar o GitHub Actions Importer para migração do Travis CI. ### 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](#configuring-credentials). O GitHub Actions Importer usa as seguintes variáveis de ambiente para se conectar à instância do Travis CI: * `GITHUB_ACCESS_TOKEN`: O personal access token (classic) é usado para criar solicitações de pull com um fluxo de trabalho convertido (requer o escopo `workflow`). * `GITHUB_INSTANCE_URL`: a URL para a instância de destino do GitHub (por exemplo, `https://github.com`). * `TRAVIS_CI_ACCESS_TOKEN`: o token de acesso à API do Travis CI usado para exibir os recursos do Travis CI. * `TRAVIS_CI_ORGANIZATION`: O nome da organização da sua instância do Travis CI. * `TRAVIS_CI_INSTANCE_URL`: a URL da instância do Travis CI. * `TRAVIS_CI_SOURCE_GITHUB_ACCESS_TOKEN`: (Opcional) O personal access token usado para autenticar com sua instância de origem do GitHub. Se isso não for fornecido, `GITHUB_ACCESS_TOKEN` será usado no lugar dele. * `TRAVIS_CI_SOURCE_GITHUB_INSTANCE_URL`: (Opcional) A URL para a instância de GitHub de origem, como . Se isso não for fornecido, `GITHUB_INSTANCE_URL` será usado no lugar dele. Essas variáveis de ambiente podem ser especificadas em um arquivo `.env.local` que é carregado pelo GitHub Actions Importer quando ele é executado. ### Como usar 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: ```shell gh actions-importer dry-run travis-ci --output-dir ./path/to/output/ --travis-ci-repository my-travis-ci-repository --source-file-path ./path/to/.travis.yml ``` #### `--allow-inactive-repositories` Use esse argumento para especificar se o GitHub Actions Importer deve incluir os repositórios inativos em uma auditoria. Se essa opção não for definida, os repositórios inativos não serão incluídos nas auditorias. ```shell gh actions-importer dry-run travis-ci --output-dir ./path/to/output/ --travis-ci-repository my-travis-ci-repository --allow-inactive-repositories ``` #### `--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. ##### Exemplo de auditoria Neste exemplo, o GitHub Actions Importer usa o arquivo de configuração YAML especificado para executar uma auditoria. ```shell gh actions-importer audit travis-ci --output-dir ./path/to/output/ --config-file-path ./path/to/travis-ci/config.yml ``` Para auditar uma instância do Travis CI usando um arquivo de configuração, o arquivo precisa estar no seguinte formato e cada valor `repository_slug` precisa ser exclusivo: ```yaml source_files: - repository_slug: travis-org-name/travis-repo-name path: path/to/.travis.yml - repository_slug: travis-org-name/some-other-travis-repo-name path: path/to/.travis.yml ``` ##### Exemplo de simulação a seco 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 da opção `--travis-ci-repository`. Em seguida, `path` é usado para efetuar pull do arquivo de origem especificado. ```shell gh actions-importer dry-run travis-ci --travis-ci-repository travis-org-name/travis-repo-name --output-dir ./output/ --config-file-path ./path/to/travis-ci/config.yml ``` ### Linguagens de projeto com suporte O GitHub Actions Importer dá suporte à migração de projetos do Travis CI nas linguagens a seguir. ### Sintaxe com suporte para pipelines do Travis CI A tabela a seguir mostra os tipos de propriedades que o GitHub Actions Importer pode converter no momento. Para obter mais detalhes de como a sintaxe do pipeline do Travis CI se alinha ao GitHub Actions, confira [Migrando de Travis CI para GitHub Actions](/pt/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions). | Travis CI | GitHub Actions | Status | | :----------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | --------------: | | ramificações |