Migrating from Travis CI with GitHub Actions Importer

Legal notice

About migrating from Travis CI with GitHub Actions Importer

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

Prerequisites

• A Travis CI account or organization with pipelines and jobs that you want to convert to GitHub Actions workflows.
• Access to create a Travis CI API access token for your account or organization.
• Среда, в которой можно запускать контейнеры на основе Linux и устанавливать необходимые средства.

  • Docker установлен и запущен.

  • GitHub Интерфейс командной строки установлен.

  Примечание.

  Контейнер GitHub Actions Importer и ИНТЕРФЕЙС командной строки не должны быть установлены на том же сервере, что и платформа CI.

Limitations

There are some limitations when migrating from Travis CI pipelines to GitHub Actions with GitHub Actions Importer.

Manual tasks

Certain Travis CI constructs must be migrated manually. These include:

• Secrets
• Unknown job properties

For more information on manual migrations, see Migrating from Travis CI to GitHub Actions.

Travis CI project languages

GitHub Actions Importer transforms Travis CI project languages by adding a set of preconfigured build tools and a default build script to the transformed workflow. If no language is explicitly declared, GitHub Actions Importer assumes a project language is Ruby.

For a list of the project languages supported by GitHub Actions Importer, see Supported project languages.

Installing the GitHub Actions Importer CLI extension

1. Установите расширение CLI GitHub Actions Importer :

   Bash

   gh extension install github/gh-actions-importer
   

2. Убедитесь, что расширение установлено:

   $ gh actions-importer -h
   Options:
     -?, -h, --help  Show help and usage information
   
   Commands:
     update     Update to the latest version of GitHub Actions Importer.
     version    Display the version of GitHub Actions Importer.
     configure  Start an interactive prompt to configure credentials used to authenticate with your CI server(s).
     audit      Plan your CI/CD migration by analyzing your current CI/CD footprint.
     forecast   Forecast GitHub Actions usage from historical pipeline utilization.
     dry-run    Convert a pipeline to a GitHub Actions workflow and output its yaml file.
     migrate    Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.
   

Configuring credentials

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

1. Create a GitHub personal access token (classic). For more information, see Управление личными маркерами доступа.

   Your token must have the workflow scope.

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

2. Create a Travis CI API access token. For more information, see Get your Travis CI API token in the Travis CI documentation.

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

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

   gh actions-importer configure
   

   The configure command will prompt you for the following information:

   • For "Which CI providers are you configuring?", use the arrow keys to select Travis CI, press Space to select it, then press Enter.
   • For "Personal access token for GitHub", enter the value of the personal access token (classic) that you created earlier, and press Enter.
   • For "Base url of the GitHub instance", press Enter to accept the default value (http://github.com).
   • For "Personal access token for Travis CI", enter the value for the Travis CI API access token that you created earlier, and press Enter.
   • For "Base url of the Travis CI instance", enter the URL of your Travis CI instance, and press Enter.
   • For "Travis CI organization name", enter the name of your Travis CI organization, and press Enter.

   An example of the output of the configure command is shown below.

   $ 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: http://github.com
   ✔ Personal access token for Travis CI: ***************
   ✔ Base url of the Travis CI instance: http://travis-ci.com
   ✔ Travis CI organization name: actions-importer-labs
   Environment variables successfully updated.
   

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

   gh actions-importer update
   

   The output of the command should be similar to below:

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

Perform an audit of Travis CI

You can use the audit command to get a high-level view of all pipelines in a Travis CI server.

The audit command performs the following steps:

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

Running the audit command

To perform an audit of a Travis CI server, run the following command in your terminal:

gh actions-importer audit travis-ci --output-dir tmp/audit

Inspecting the audit results

Файлы в указанном выходном каталоге содержат результаты аудита. audit_summary.md Ознакомьтесь с файлом с сводкой результатов аудита.

Сводка аудита содержит следующие разделы.

Pipelines

Раздел "Конвейеры" содержит высокоуровневую статистику относительно скорости преобразования, выполняемой GitHub Actions Importer.

Ниже перечислены некоторые ключевые термины, которые могут отображаться в разделе "Конвейеры":

• Успешные конвейеры имели 100 % конструкций конвейера и отдельные элементы, преобразованные автоматически в их эквивалент GitHub Actions.
• Частично успешные конвейеры были преобразованы все конструкции конвейера, однако существовали некоторые отдельные элементы, которые не были автоматически преобразованы в их эквивалент GitHub Actions.
• Неподдерживаемые конвейеры — это типы определений, которые не поддерживаются GitHub Actions Importer.
• Неудачные конвейеры столкнулись с неустранимой ошибкой при преобразовании. Это может произойти по одной из трех причин:
  • Конвейер изначально был неправильно настроен и недопустим.
  • При преобразовании данных GitHub Actions Importer возникла внутренняя ошибка.
  • Произошел неудачный сетевой ответ, который привел к недоступности конвейера, что часто связано с недопустимыми учетными данными.

Этапы сборки

В разделе "Шаги сборки" содержится обзор отдельных шагов сборки, используемых во всех конвейерах, и количество автоматически преобразованных GitHub Actions Importer.

Ниже приведены некоторые ключевые термины, которые могут отображаться в разделе "Шаги сборки".

• Известный **** шаг сборки — это шаг, который был автоматически преобразован в эквивалентное действие.
• ** Неизвестный **шаг сборки — это шаг, который не был автоматически преобразован в эквивалентное действие.
• Неподдерживаемый **** шаг сборки — это шаг, который является следующим:
  • В основном не поддерживается GitHub Actions.
  • Настроено таким образом, что несовместимо с данными GitHub Actions.
• Действие **** — это список действий, которые использовались в преобразованных рабочих процессах. Это может быть важно для:
  • Если вы используете GitHub Enterprise Server, собирайте список действий для синхронизации с экземпляром.
  • Определение списка разрешений на уровне организации используемых действий. Этот список действий — это полный список действий, которые могут потребоваться для проверки вашей группы безопасности или соответствия требованиям.

Задачи вручную

В разделе "Задачи вручную" содержится обзор задач, которые GitHub Actions Importer не могут выполняться автоматически, и что необходимо выполнить вручную.

Ниже перечислены некоторые ключевые термины, которые могут отображаться в разделе "Задачи вручную".

• Секрет — это репозиторий или секрет уровня организации, используемый в преобразованных конвейерах. Эти секреты необходимо создать вручную в GitHub Actions для правильной работы этих конвейеров. Дополнительные сведения см. в разделе Using secrets in GitHub Actions.
• Локальное средство выполнения ссылается на метку бегуна, на который ссылается преобразованный конвейер, который не является GitHub, размещенным в runner. Необходимо вручную определить эти средства выполнения для правильной работы этих конвейеров.

Файлы

Последний раздел отчета аудита содержит манифест всех файлов, записанных на диск во время аудита.

Каждый файл конвейера содержит различные файлы, включенные в аудит, в том числе:

• Исходный конвейер, определенный в GitHub.
• Все сетевые ответы, используемые для преобразования конвейера.
• Преобразованный файл рабочего процесса.
• Трассировки стека, которые можно использовать для устранения неполадок с неудачным преобразованием конвейера.

Кроме того, workflow_usage.csv файл содержит разделенный запятыми список всех действий, секретов и средств выполнения, используемых каждым успешно преобразованным конвейером. Это может быть полезно для определения рабочих процессов, которые используют действия, секреты или средства выполнения, и могут быть полезны для выполнения проверок безопасности.

Forecast potential build runner usage

You can use the forecast command to forecast potential GitHub Actions usage by computing metrics from completed pipeline runs in your Travis CI server.

Running the forecast command

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

gh actions-importer forecast travis-ci --output-dir tmp/forecast

Inspecting the forecast report

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

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

• The job count is the total number of completed jobs.
• The pipeline count is the number of unique pipelines used.
• Execution time describes the amount of time a runner spent on a job. This metric can be used to help plan for the cost of GitHub-hosted runners.
  • This metric is correlated to how much you should expect to spend in GitHub Actions. This will vary depending on the hardware used for these minutes. You can use the GitHub Actions pricing calculator to estimate the costs.
• Queue time metrics describe the amount of time a job spent waiting for a runner to be available to execute it.
• Concurrent jobs metrics describe the amount of jobs running at any given time. This metric can be used to define the number of runners you should configure.

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

Perform a dry-run migration of a Travis CI pipeline

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

To perform a dry run of migrating your Travis CI pipelines to GitHub Actions, run the following command in your terminal, replacing my-travis-ci-repository with the name of your Travis CI repository.

gh actions-importer dry-run travis-ci --travis-ci-repository my-travis-ci-repository --output-dir tmp/dry-run

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

Если есть что-либо, что GitHub Actions Importer не удалось преобразовать автоматически, например неизвестные шаги сборки или частично успешный конвейер, может потребоваться создать пользовательские преобразователи для дальнейшей настройки процесса преобразования. Дополнительные сведения см. в разделе Extending GitHub Actions Importer with custom transformers.

Perform a production migration of a Travis CI pipeline

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

Running the migrate command

To migrate a Travis CI pipeline to GitHub Actions, run the following command in your terminal, replacing the target-url value with the URL for your GitHub repository, and my-travis-ci-repository with the name of your Travis CI repository.

gh actions-importer migrate travis-ci --target-url http://github.com/octo-org/octo-repo --output-dir tmp/migrate --travis-ci-repository my-travis-ci-repository

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

$ gh actions-importer migrate travis-ci --target-url http://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: 'http://github.com/octo-org/octo-repo/pull/1'

Проверка запроса на вытягивание

Выходные данные из успешного migrate выполнения команды содержат ссылку на новый запрос на вытягивание, который добавляет преобразованный рабочий процесс в репозиторий.

Ниже приведены некоторые важные элементы запроса на вытягивание:

• В описании запроса на вытягивание раздел с именем "Вручную", в котором перечислены шаги, которые необходимо выполнить вручную, прежде чем завершить перенос конвейеров на GitHub Actions. Например, в этом разделе может быть описано создание секретов, используемых в рабочих процессах.
• Преобразованный файл рабочих процессов. Выберите вкладку "**Измененные файлы" в запросе **на вытягивание, чтобы просмотреть файл рабочего процесса, который будет добавлен в репозиторий GitHub .

После завершения проверки запроса на вытягивание его можно объединить, чтобы добавить рабочий процесс в репозиторий GitHub .

Reference

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

Using environment variables

GitHub Actions Importer использует переменные среды для конфигурации проверки подлинности. Эти переменные задаются при выполнении процесса конфигурации с помощью configure команды. Дополнительные сведения см. в разделе "Настройка учетных данных".

GitHub Actions Importer uses the following environment variables to connect to your Travis CI instance:

• GITHUB_ACCESS_TOKEN: The personal access token (classic) used to create pull requests with a converted workflow (requires the workflow scope).
• GITHUB_INSTANCE_URL: The URL to the target GitHub instance (for example, http://github.com).
• TRAVIS_CI_ACCESS_TOKEN: The Travis CI API access token used to view Travis CI resources.
• TRAVIS_CI_ORGANIZATION: The organization name of your Travis CI instance.
• TRAVIS_CI_INSTANCE_URL: The URL of the Travis CI instance.
• TRAVIS_CI_SOURCE_GITHUB_ACCESS_TOKEN: (Optional) The personal access token used to authenticate with your source GitHub instance. If not provided, GITHUB_ACCESS_TOKEN will be used instead.
• TRAVIS_CI_SOURCE_GITHUB_INSTANCE_URL: (Optional) The URL to the source GitHub instance, such as http://github.com. If not provided, GITHUB_INSTANCE_URL will be used instead.

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

Using optional arguments

Существуют необязательные аргументы, которые можно использовать с подкомандами GitHub Actions Importer для настройки миграции.

--source-file-path

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

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

For example:

gh actions-importer dry-run travis-ci --output-dir ./path/to/output/ --travis-ci-repository my-travis-ci-repository --source-file-path ./path/to/.travis.yml

--allow-inactive-repositories

You can use this argument to specify whether GitHub Actions Importer should include inactive repositories in an audit. If this option is not set, inactive repositories are not included in audits.

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

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

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

Audit example

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

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

To audit a Travis CI instance using a configuration file, the file must be in the following format and each repository_slug value must be unique:

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

Dry run example

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

The pipeline is selected by matching the repository_slug in the configuration file to the value of the --travis-ci-repository option. The path is then used to pull the specified source file.

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

Supported project languages

GitHub Actions Importer supports migrating Travis CI projects in the following languages.

• android
• bash
• c
• clojure
• c++
• crystal
• c#
• d
• dart
• elixir
• erlang
• generic
• go
• groovy
• haskell
• haxe
• java
• julia
• matlab
• minimal
• nix
• node_js
• objective-c
• perl
• perl6
• php
• python
• r
• ruby
• rust
• scala
• sh
• shell
• smalltalk
• swift

Supported syntax for Travis CI pipelines

The following table shows the type of properties GitHub Actions Importer is currently able to convert. For more details about how Travis CI pipeline syntax aligns with GitHub Actions, see Migrating from Travis CI to GitHub Actions.

Travis CI	GitHub Actions	Status
branches	on.<push>.<branches>	Supported
build_pull_requests	on.<pull_request>	Supported
env	env jobs.<job_id>.env jobs.<job_id>.steps.env	Supported
if	jobs.<job_id>.if	Supported
job	jobs.<job_id> jobs.<job_id>.name	Supported
matrix	jobs.<job_id>.strategy jobs.<job_id>.strategy.fail-fast jobs.<job_id>.strategy.matrix	Supported
os & dist	runners	Supported
scripts	jobs.<job_id>.steps	Supported
stages	jobs	Supported
env	on	Partially supported
branches	on.<push>.<tags> on.<push>.paths	Unsupported
build_pull_requests	on.<pull_request>.<branches> on.<pull_request>.<tags> on.<pull_request>.paths	Unsupported
cron triggers	on.schedule on.workflow_run	Unsupported
env	jobs.<job_id>.timeout-minutes on.<event_name>.types	Unsupported
job	jobs.<job_id>.container	Unsupported
os & dist	self hosted runners	Unsupported

For information about supported Travis CI constructs, see the github/gh-actions-importer repository.

Environment variables syntax

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

Travis CI	GitHub Actions
$CONTINUOUS_INTEGRATION	$CI
$USER	${{ github.actor }}
$HOME	${{ github.workspace }}
$TRAVIS_BRANCH	${{ github.ref }}
$TRAVIS_BUILD_DIR	${{ github.workspace }}
$TRAVIS_BUILD_ID	${{ github.run_number }}
$TRAVIS_BUILD_NUMBER	${{ github.run_id }}
$TRAVIS_COMMIT	${{ github.sha }}
$TRAVIS_EVENT_TYPE	${{ github.event_name }}
$TRAVIS_PULL_REQUEST_BRANCH	${{ github.base_ref }}
$TRAVIS_PULL_REQUEST	${{ github.event.number }}
$TRAVIS_PULL_REQUEST_SHA	${{ github.head.sha }}
$TRAVIS_PULL_REQUEST_SLUG	${{ github.repository }}
$TRAVIS_TAG	${{ github.ref }}
$TRAVIS_OS_NAME	${{ runner.os }}
$TRAVIS_JOB_ID	${{ github.job }}
$TRAVIS_REPO_SLUG	${{ github.repository_owner/github.repository }}
$TRAVIS_BUILD_WEB_URL	${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

Legal notice

Части были адаптированы в соответствии с http://github.com/github/gh-actions-importer/ лицензией 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.