# Переход с 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 для вашей учетной записи или организации. * Среда, в которой можно запускать контейнеры на основе Linux и устанавливать необходимые средства. * Docker установлен [](https://docs.docker.com/get-docker/) и запущен. * [GitHub Интерфейс командной строки](https://cli.github.com) установлен. > \[!NOTE] > Контейнер GitHub Actions Importer и ИНТЕРФЕЙС командной строки не должны быть установлены на том же сервере, что и платформа CI. ### Ограничения Существуют некоторые ограничения при миграции из конвейеров CI Travis в GitHub Actions с GitHub Actions Importer. #### Задачи вручную Некоторые конструкции CI Travis должны переноситься вручную. Например: * Секреты * Неизвестные свойства задания Дополнительные сведения о миграции вручную см. в разделе [Переход с Travis CI на GitHub Actions](/ru/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-travis-ci). #### Языки проекта Travis CI GitHub Actions Importer преобразует языки проекта Travis CI, добавив набор предварительно настроенных средств сборки и скрипт сборки по умолчанию в преобразованный рабочий процесс. Если язык явно не объявлен, предполагается, GitHub Actions Importer что язык проекта — Ruby. Список языков проекта, поддерживаемых языками GitHub Actions Importerпроекта, см. на [поддерживаемых языках проекта](#supported-project-languages). ## Установка GitHub Actions Importer расширения CLI 1. Установите расширение CLI GitHub Actions Importer : ```bash copy gh extension install github/gh-actions-importer ``` 2. Убедитесь, что расширение установлено: ```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. ``` ## Настройка учетных данных Команда `configure` CLI используется для задания необходимых учетных данных и параметров GitHub Actions Importer при работе с Travis CI и GitHub. 1. Создайте GitHubpersonal access token (classic). Дополнительные сведения см. в разделе [Управление личными маркерами доступа](/ru/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). У маркера `workflow` должна быть область. После создания маркера скопируйте его и сохраните его в безопасном расположении для последующего использования. 2. Создайте маркер доступа к API CI Travis. Дополнительные сведения см. в статье ["Получение маркера](https://docs.travis-ci.com/user/migrate/travis-migrate-to-apps-gem-guide/#4-get-your-travis-ci-api-token) API CI Travis" в документации по travis CI. После создания маркера скопируйте его и сохраните его в безопасном расположении для последующего использования. 3. В терминале выполните GitHub Actions Importer`configure` команду CLI: ```shell 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 For Travis CI" введите значение для созданного ранее маркера доступа к API Travis CI и нажмите клавишу ВВОД. * В поле "Базовый URL-адрес экземпляра CI Travis" введите URL-адрес экземпляра CI Travis и нажмите клавишу ВВОД. * В поле "Имя организации Travis CI" введите имя организации Travis CI и нажмите клавишу ВВОД. Ниже показан пример выходных `configure` данных команды. ```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. В вашем терминале выполните GitHub Actions Importer`update` команду CLI, чтобы подключиться к GitHub PackagesContainer registry и убедиться, что образ контейнера обновлен до последней версии: ```shell gh actions-importer update ``` Выходные данные команды должны выглядеть следующим образом: ```shell 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, выполните следующую команду в терминале: ```shell 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](/ru/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets). * **Локальное средство выполнения** ссылается на метку бегуна, на который ссылается преобразованный конвейер, который не является размещенным GitHubrunner. Необходимо вручную определить эти средства выполнения для правильной работы этих конвейеров. #### Файлы Последний раздел отчета аудита содержит манифест всех файлов, записанных на диск во время аудита. Каждый файл конвейера содержит различные файлы, включенные в аудит, в том числе: * Исходный конвейер, определенный в GitHub. * Все сетевые ответы, используемые для преобразования конвейера. * Преобразованный файл рабочего процесса. * Трассировки стека, которые можно использовать для устранения неполадок с неудачным преобразованием конвейера. Кроме того, `workflow_usage.csv` файл содержит разделенный запятыми список всех действий, секретов и средств выполнения, используемых каждым успешно преобразованным конвейером. Это может быть полезно для определения рабочих процессов, которые используют действия, секреты или средства выполнения, и могут быть полезны для выполнения проверок безопасности. ## Прогнозирование потенциального использования средства выполнения сборки С помощью `forecast` команды можно прогнозировать потенциальное GitHub Actions использование, вычисляя метрики из завершенного конвейера на сервере CI Travis. ### Выполнение команды прогноза Чтобы выполнить прогноз возможного GitHub Actions использования, выполните следующую команду в вашем терминале. По умолчанию GitHub Actions Importer включает предыдущие семь дней в прогнозный отчёт. ```shell gh actions-importer forecast travis-ci --output-dir tmp/forecast ``` ### Проверка отчета прогноза Файл `forecast_report.md` в указанном выходном каталоге содержит результаты прогноза. Ниже перечислены некоторые ключевые термины, которые могут отображаться в отчете прогноза: * Число **заданий** — общее количество завершенных заданий. * Число **конвейеров — это количество уникальных используемых конвейеров** . * **Время** выполнения описывает время выполнения, затраченное на задание. Этот показатель помогает планировать стоимость GitHub-hosted runners. * Этот показатель коррелирует с тем, сколько вы должны ожидать в GitHub Actions. Это зависит от оборудования, используемого в эти минуты. Вы можете использовать [GitHub Actions калькулятор ценообразования](https://github.com/pricing/calculator) , чтобы оценить затраты. * **Метрики времени** очереди описывают время, затраченное на выполнение задания, ожидающего доступности средства выполнения. * **Метрики параллельных заданий** описывают количество заданий, выполняемых в любое время. Эту метрику можно использовать для определения количества модулей выполнения, которые необходимо настроить. Кроме того, эти метрики определяются для каждой очереди запуска в Travis CI. Это особенно полезно, если имеется сочетание размещенных или локальных runners, или компьютеров с высокой или низкой спецификацией, поэтому вы можете видеть метрики, относящиеся к различным типам runners. ## Выполнение миграции конвейера CI travis с сухим запуском Вы можете использовать `dry-run` команду для преобразования конвейера CI Travis в эквивалентный GitHub Actions рабочий процесс. Сухой запуск создает выходные файлы в указанном каталоге, но не открывает запрос на вытягивание для переноса конвейера. Чтобы выполнить сухой запуск переноса конвейеров GitHub ActionsCI Travis в терминал, выполните следующую команду в терминале, заменив `my-travis-ci-repository` его именем репозитория Travis CI. ```shell gh actions-importer dry-run travis-ci --travis-ci-repository my-travis-ci-repository --output-dir tmp/dry-run ``` Журналы сухого запуска и преобразованных файлов рабочих процессов можно просмотреть в указанном выходном каталоге. Если нет ничего, что GitHub Actions Importer не удалось преобразовать автоматически, например неизвестные шаги сборки или частично успешный конвейер, может потребоваться создать настраиваемые преобразователи для дальнейшей настройки процесса преобразования. Дополнительные сведения см. в разделе [Расширение импортера GitHub Actions с пользовательскими трансформерами](/ru/actions/reference/github-actions-importer/custom-transformers). ## Выполнение рабочей миграции конвейера CI Travis Вы можете использовать `migrate` команду для преобразования конвейера CI Travis и открытия запроса на вытягивание с эквивалентным GitHub Actions рабочим процессом. ### Выполнение команды миграции Чтобы перенести конвейер GitHub ActionsCI Travis, выполните следующую команду в терминале, заменив `target-url` значение URL-адресом GitHub репозитория и `my-travis-ci-repository` именем репозитория 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 ``` Выходные данные команды содержат URL-адрес запроса на вытягивание, который добавляет преобразованный рабочий процесс в репозиторий. Пример успешного вывода аналогичен следующему: ```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' ``` ### Проверка запроса на вытягивание Выходные данные из успешного `migrate` выполнения команды содержат ссылку на новый запрос на вытягивание, который добавляет преобразованный рабочий процесс в репозиторий. Ниже приведены некоторые важные элементы запроса на вытягивание: * В описании запроса на вытягивание раздел с именем **"Вручную", в котором перечислены шаги**, которые необходимо выполнить вручную, прежде чем завершить перенос конвейеров на GitHub Actions. Например, в этом разделе может быть описано создание секретов, используемых в рабочих процессах. * Преобразованный файл рабочих процессов. Выберите вкладку "\*\*Измененные файлы" в запросе \*\*на вытягивание, чтобы просмотреть файл рабочего процесса, который будет добавлен в репозиторий GitHub . После завершения проверки запроса на вытягивание его можно объединить, чтобы добавить рабочий процесс в репозиторий GitHub . ## Справочные материалы В этом разделе содержатся справочные сведения о переменных среды, необязательных аргументах и поддерживаемых синтаксисах при GitHub Actions Importer миграции из Travis CI. ### Использование переменных среды GitHub Actions Importer использует переменные среды для конфигурации проверки подлинности. Эти переменные задаются при выполнении процесса конфигурации с помощью `configure` команды. Дополнительные сведения см. в [разделе "Настройка учетных](#configuring-credentials) данных". 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 экземпляра, например . Если это не указано, `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 использовать указанный путь к исходному файлу. Например: ```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` Этот аргумент можно использовать для указания того, следует ли GitHub Actions Importer включать неактивные репозитории в аудит. Если этот параметр не задан, неактивные репозитории не включены в аудиты. ```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` Аргумент можно использовать `--config-file-path` с `audit``dry-run`подкомандами и `migrate` подкомандами. По умолчанию GitHub Actions Importer получает содержимое конвейера из системы контроля исходного кода. Аргумент `--config-file-path` подсказывает GitHub Actions Importer использовать указанные исходные файлы. ##### Пример аудита В этом примере GitHub Actions Importer используется указанный конфигурационный файл YAML для проведения аудита. ```shell gh actions-importer audit travis-ci --output-dir ./path/to/output/ --config-file-path ./path/to/travis-ci/config.yml ``` Для аудита экземпляра CI Travis с помощью файла конфигурации файл должен иметь следующий формат, и каждое `repository_slug` значение должно быть уникальным: ```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 ``` ##### Пример сухого запуска В этом примере GitHub Actions Importer используется указанный конфигурационный файл YAML в качестве исходного файла для проведения пробного запуска. Конвейер выбирается путем сопоставления `repository_slug` в файле конфигурации со значением `--travis-ci-repository` параметра. Затем `path` используется для извлечения указанного исходного файла. ```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 ``` ### Поддерживаемые языки проектов GitHub Actions Importer поддерживает перенос проектов CI Travis на следующих языках. ### Поддерживаемый синтаксис для конвейеров CI Travis В следующей таблице показан тип свойств GitHub Actions Importer , которые в настоящее время можно преобразовать. Дополнительные сведения о выравнивании синтаксиса конвейера TRAvis CI см. в GitHub Actionsразделе [Переход с Travis CI на GitHub Actions](/ru/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-travis-ci). | Трэвис CI | GitHub Actions | Состояние | | :-------------------- | :----------------------------------------------------------------------------------------------------------------------- | ----------------------: | | branches |