Переход с Travis CI с импортером GitHub Actions

Узнайте, как использовать GitHub Actions Importer для автоматизации миграции конвейеров CI Travis на GitHub Actions.

В этой статье

О миграции с Travis CI с импортером GitHub Actions

Приведенные ниже инструкции помогут вам настроить среду для использования GitHub Actions Importer для переноса конвейеров CI Travis в GitHub Actions.

Необходимые компоненты

  • Учетная запись или организация Travis CI с конвейерами и заданиями, которые необходимо преобразовать в рабочие процессы GitHub Actions.
  • Доступ к созданию маркера доступа к API CI Travis для вашей учетной записи или организации.

Ограничения

При миграции из конвейеров CI Travis в GitHub Actions с GitHub Actions Importer.

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

Некоторые конструкции CI Travis должны переноситься вручную. Например:

  • Секреты
  • Неизвестные свойства задания

Дополнительные сведения о миграции вручную см. в разделе Переход с Travis CI на GitHub Actions.

Языки проекта Travis CI

GitHub Actions Importer преобразует языки проекта Travis CI путем добавления набора предварительно настроенных средств сборки и скрипта сборки по умолчанию в преобразованный рабочий процесс. Если язык явно не объявлен, GitHub Actions Importer предполагает, что язык проекта — Ruby.

Список языков проекта, поддерживаемых GitHub Actions Importer, см. на поддерживаемых языках проекта.

Установка расширения CLI GitHub Actions Importer

  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.

Настройка учетных данных

Команда configure CLI используется для задания необходимых учетных данных и параметров для GitHub Actions Importer при работе с Travis CI и GitHub.

  1. Создайте GitHub personal access token (classic). Дополнительные сведения см. в разделе Управление личными маркерами доступа.

    У маркера workflow должна быть область.

    После создания маркера скопируйте его и сохраните его в безопасном расположении для последующего использования.

  2. Создайте маркер доступа к API CI Travis. Дополнительные сведения см. в статье "Получение маркера API CI Travis" в документации по travis CI.

    После создания маркера скопируйте его и сохраните его в безопасном расположении для последующего использования.

  3. В терминале выполните команду CLI GitHub Actions Importer configure :

    gh actions-importer configure

    В командной строке появится следующая configure информация:

    • Для вопроса «Каких провайдеров CI вы настраиваете?» используйте стрелки, чтобы выбрать Travis CI, нажмите Space чтобы выбрать его, затем нажмите Enter.
    • Для «Personal access token for GitHub введите значение personal access token (classic), которое вы создали ранее, и нажмите Enter.
    • Для «Базового URL GitHub экземпляра» нажмите Enter чтобы принять значение по умолчанию (https://github.com).
    • В поле "Personal access token для Travis CI" введите значение маркера доступа к API Travis CI, созданного ранее, и нажмите клавишу ВВОД.
    • В поле "Базовый URL-адрес экземпляра CI Travis" введите URL-адрес экземпляра CI Travis и нажмите клавишу ВВОД.
    • В поле "Имя организации Travis CI" введите имя организации Travis CI и нажмите клавишу ВВОД.

    Ниже показан пример выходных configure данных команды.

    $ 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. В терминале выполните команду GitHub Actions Importer update CLI для подключения к GitHub Packages Container registry и убедитесь, что образ контейнера обновлен до последней версии:

    gh actions-importer update

    Выходные данные команды должны выглядеть следующим образом:

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

Выполнение аудита CI Travis

С помощью audit команды можно получить высокоуровневое представление всех конвейеров на сервере CI Travis.

Команда audit выполняет следующие действия.

  1. Извлекает все проекты, определенные на сервере CI Travis.
  2. Преобразует каждый конвейер в эквивалентный рабочий процесс GitHub Actions .
  3. Создает отчет, в котором приводится сводка о том, как полная и сложная миграция возможна с помощью GitHub Actions Importer.

Выполнение команды аудита

Чтобы выполнить аудит сервера CI Travis, выполните следующую команду в терминале:

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

Проверка результатов аудита

Файлы в указанном выходном каталоге содержат результаты аудита. 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 для правильной работы этих конвейеров. Дополнительные сведения см. в разделе Использование секретов в GitHub Actions.
  • Локальное средство выполнения ссылается на метку бегуна, на который ссылается преобразованный конвейер, который не является GitHub, размещенным в runner. Необходимо вручную определить эти средства выполнения для правильной работы этих конвейеров.

Файлы

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

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

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

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

Прогнозирование потенциального использования средства выполнения сборки

Вы можете использовать forecast команду для прогнозирования потенциального использования данных GitHub Actions с помощью вычислений метрик из завершенного конвейера, запущенного на сервере CI Travis.

Выполнение команды прогноза

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

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

Проверка отчета прогноза

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

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

  • Число заданий — общее количество завершенных заданий.
  • Число конвейеров — это количество уникальных используемых конвейеров .
  •         **Время** выполнения описывает время выполнения, затраченное на задание. Эту метрику можно использовать для планирования стоимости GitHubразмещенных средств выполнения.
    • Эта метрика сопоставляется с тем, сколько следует потратить в GitHub Actions. Это зависит от оборудования, используемого в эти минуты. Вы можете использовать калькулятор цен GitHub Actions для оценки затрат.
  •         **Метрики времени** очереди описывают время, затраченное на выполнение задания, ожидающего доступности средства выполнения.

  •         **Метрики параллельных заданий** описывают количество заданий, выполняемых в любое время. Эту метрику можно использовать для определения количества модулей выполнения, которые необходимо настроить.

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

Выполнение миграции конвейера CI travis с сухим запуском

Вы можете использовать dry-run команду для преобразования конвейера CI Travis в эквивалентный рабочий процесс GitHub Actions . Сухой запуск создает выходные файлы в указанном каталоге, но не открывает запрос на вытягивание для переноса конвейера.

Чтобы выполнить сухой запуск миграции конвейеров CI Travis в GitHub Actions, выполните следующую команду в терминале, заменив my-travis-ci-repository имя репозитория TRAvis CI.

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

Журналы сухого запуска и преобразованных файлов рабочих процессов можно просмотреть в указанном выходном каталоге.

Выполнение рабочей миграции конвейера CI Travis

Вы можете использовать migrate команду для преобразования конвейера CI Travis и открытия запроса на вытягивание с эквивалентным рабочим процессом GitHub Actions.

Выполнение команды миграции

Чтобы перенести конвейер CI Travis в GitHub Actions, выполните следующую команду в терминале, заменив target-url значение URL-адресом репозитория GitHub и my-travis-ci-repository именем репозитория Travis CI.

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

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

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

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

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

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

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

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

Справочные материалы

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

Использование переменных среды

GitHub Actions Importer использует следующие переменные среды для подключения к экземпляру CI Travis:

  •         `GITHUB_ACCESS_TOKEN`: personal access token (classic) используется для создания запросов на вытягивание с преобразованным рабочим процессом (требуется `workflow` область).

  •         `GITHUB_INSTANCE_URL`: URL-адрес целевого экземпляра GitHub (например, `https://github.com`).

  •         `TRAVIS_CI_ACCESS_TOKEN`: маркер доступа к API CI Travis, используемый для просмотра ресурсов CI Travis.

  •         `TRAVIS_CI_ORGANIZATION`: имя организации экземпляра CI Travis.

  •         `TRAVIS_CI_INSTANCE_URL`: URL-адрес экземпляра CI Travis.

  •         `TRAVIS_CI_SOURCE_GITHUB_ACCESS_TOKEN`: (Опционально) personal access token используются для аутентификации с вашим исходным GitHub экземпляром. Если это не указано, `GITHUB_ACCESS_TOKEN` вместо этого будет использоваться.

  •         `TRAVIS_CI_SOURCE_GITHUB_INSTANCE_URL`: (По желанию) URL исходного GitHub экземпляра, например https://github.com. Если это не указано, `GITHUB_INSTANCE_URL` вместо этого будет использоваться.

Эти переменные среды можно указать в .env.local файле, загруженном GitHub Actions Importer при запуске.

Использование необязательных аргументов

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

--source-file-path

Аргумент можно использовать --source-file-path с forecast``dry-runподкомандами или migrate подкомандами.

По умолчанию GitHub Actions Importer извлекает содержимое конвейера из системы управления версиями. Аргумент --source-file-path указывает GitHub Actions Importer использовать указанный путь к исходному файлу.

Например:

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

Этот аргумент можно использовать для указания того, должны ли GitHub Actions Importer включать неактивные репозитории в аудит. Если этот параметр не задан, неактивные репозитории не включены в аудиты.

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

Аргумент можно использовать --config-file-path с audit``dry-runподкомандами и migrate подкомандами.

По умолчанию GitHub Actions Importer извлекает содержимое конвейера из системы управления версиями. Аргумент --config-file-path указывает GitHub Actions Importer использовать указанные исходные файлы.

Пример аудита

В этом примере GitHub Actions Importer использует указанный файл конфигурации YAML для выполнения аудита.

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

Для аудита экземпляра CI Travis с помощью файла конфигурации файл должен иметь следующий формат, и каждое repository_slug значение должно быть уникальным:

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
Пример сухого запуска

В этом примере GitHub Actions Importer использует указанный файл конфигурации YAML в качестве исходного файла для выполнения сухого запуска.

Конвейер выбирается путем сопоставления repository_slug в файле конфигурации со значением --travis-ci-repository параметра. Затем path используется для извлечения указанного исходного файла.

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

Поддерживаемые языки проектов

GitHub Actions Importer поддерживает перенос проектов CI Travis на следующих языках.

  • 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

Поддерживаемый синтаксис для конвейеров CI Travis

В следующей таблице показан тип свойств GitHub Actions Importer в настоящее время можно преобразовать. Дополнительные сведения о том, как синтаксис конвейера Travis CI соответствует GitHub Actions, см. в разделе Переход с Travis CI на GitHub Actions.

Трэвис CIGitHub ActionsСостояние
branches
  • on.<push>.<branches>
Поддерживается
build_pull_requests
  • on.<pull_request>
Поддерживается
env
  • env
  • jobs.<job_id>.env
  • jobs.<job_id>.steps.env
Поддерживается
if
  • jobs.<job_id>.if
Поддерживается
задание
  • jobs.<job_id>
  • jobs.<job_id>.name
Поддерживается
матрицы
  • jobs.<job_id>.strategy
  • jobs.<job_id>.strategy.fail-fast
  • jobs.<job_id>.strategy.matrix
Поддерживается
OS & Dist
  • runners
Поддерживается
Скрипты
  • jobs.<job_id>.steps
Поддерживается
Этапах
  • jobs
Поддерживается
env
  • on
Частично поддерживается
branches
  • on.<push>.<tags>
  • on.<push>.paths
Не поддерживается
build_pull_requests
  • on.<pull_request>.<branches>
  • on.<pull_request>.<tags>
  • on.<pull_request>.paths
Не поддерживается
триггеры cron
  • on.schedule
  • on.workflow_run
Не поддерживается
env
  • jobs.<job_id>.timeout-minutes
  • on.<event_name>.types
Не поддерживается
задание
  • jobs.<job_id>.container
Не поддерживается
OS & Dist
  • self hosted runners
Не поддерживается

Сведения о поддерживаемых конструкциях CI Travis см. в репозиторииgithub/gh-actions-importer.

Синтаксис переменных среды

GitHub Actions Importer использует сопоставление в таблице ниже для преобразования переменных среды CI Travis по умолчанию в ближайший эквивалент в GitHub Actions.

Трэвис CIGitHub 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 }}

Части были адаптированы в соответствии с https://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.