Миграция с CircleCI с импортером GitHub Actions

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

В этой статье

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

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

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

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

Ограничения

При миграции из CircleCI в GitHub Actions с GitHub Actions Importerсуществуют некоторые ограничения:

  • Автоматическое кэширование между заданиями разных рабочих процессов не поддерживается.
  • Эта audit команда поддерживается только при использовании учетной записи организации CircleCI. dry-run Команды migrate можно использовать с организацией CircleCI или учетной записью пользователя.

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

Некоторые конструкции CircleCI необходимо перенести вручную. Например:

  • Контексты
  • Переменные среды уровня проекта
  • Неизвестные свойства задания
  • Неизвестные orbs

Установка расширения 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 при работе с CircleCI и GitHub.

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

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

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

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

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

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

    gh actions-importer configure

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

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

    Ниже показан пример configure команды:

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

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

С помощью audit команды можно получить высокоуровневое представление всех проектов в организации CircleCI.

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

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

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

Чтобы выполнить аудит организации CircleCI, выполните следующую команду в терминале:

gh actions-importer audit circle-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 файл содержит разделенный запятыми список всех действий, секретов и средств выполнения, используемых каждым успешно преобразованным конвейером. Это может быть полезно для определения рабочих процессов, которые используют действия, секреты или средства выполнения, и могут быть полезны для выполнения проверок безопасности.

Прогнозирование потенциального использования данных GitHub Actions

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

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

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

gh actions-importer forecast circle-ci --output-dir tmp/forecast_reports

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

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

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

  • Число заданий — общее количество завершенных заданий.

  • Число конвейеров — это количество уникальных используемых конвейеров .

  •         **Время** выполнения описывает время выполнения, затраченное на задание. Эту метрику можно использовать для планирования стоимости GitHubразмещенных средств выполнения.

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

  •         **Метрики времени** очереди описывают время, затраченное на выполнение задания, ожидающего доступности средства выполнения.

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

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

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

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

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

gh actions-importer dry-run circle-ci --output-dir tmp/dry-run --circle-ci-project my-circle-ci-project

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

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

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

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

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

gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project

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

$ gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project
[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 для миграции из CircleCI.

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

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

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

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

  •         `CIRCLE_CI_ACCESS_TOKEN`: личный маркер API CircleCI, используемый для проверки подлинности в экземпляре CircleCI.

  •         `CIRCLE_CI_INSTANCE_URL`: URL-адрес экземпляра CircleCI (например, `https://circleci.com`). Если переменная не настроена, `https://circleci.com` используется в качестве значения по умолчанию.

  •         `CIRCLE_CI_ORGANIZATION`: имя организации экземпляра CircleCI.

  •         `CIRCLE_CI_PROVIDER`: расположение, в котором хранится исходный файл конвейера (например `github`, ). В настоящее время поддерживается только GitHub .

  •         `CIRCLE_CI_SOURCE_GITHUB_ACCESS_TOKEN` (Необязательно): personal access token (classic) используется для проверки подлинности с помощью исходного экземпляра GitHub (требуется `repo` область). Если это не указано, вместо этого используется значение `GITHUB_ACCESS_TOKEN` .

  •         `CIRCLE_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 использовать указанный путь к исходному файлу.

Например:

gh actions-importer dry-run circle-ci --output-dir ./output/ --source-file-path ./path/to/.circleci/config.yml

Если вы хотите предоставить несколько исходных файлов при запуске forecast подкоманда, можно использовать сопоставление шаблонов в значении пути к файлу. Например, gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json предоставляет GitHub Actions Importer любым исходным файлам, соответствующим пути к файлу ./tmp/previous_forecast/jobs/*.json .

--config-file-path

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

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

Аргумент --config-file-path также можно использовать для указания репозитория преобразованного составного действия.

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

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

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

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

source_files:
  - repository_slug: circle-org-name/circle-project-name
    path: path/to/.circleci/config.yml
  - repository_slug: circle-org-name/some-other-circle-project-name
    path: path/to/.circleci/config.yml
Пример сухого запуска

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

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

gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml
Указание репозитория преобразованных составных действий

GitHub Actions Importer использует файл YAML, --config-file-path предоставленный аргументу, для определения репозитория, в который переносятся преобразованные составные действия.

Чтобы начать, необходимо выполнить аудит без аргумента --config-file-path :

gh actions-importer audit circle-ci --output-dir ./output/

Выходные данные этой команды будут содержать файл с именем config.yml , содержащий список всех составных действий, преобразованных GitHub Actions Importer. Например, config.yml файл может содержать следующее содержимое:

composite_actions:
  - name: my-composite-action.yml
    target_url: https://github.com/octo-org/octo-repo
    ref: main

Этот файл можно использовать для указания репозитория и ссылки на повторно используемый рабочий процесс или составное действие. Затем можно использовать --config-file-path аргумент для предоставления config.yml файла GitHub Actions Importer. Например, этот файл можно использовать при выполнении migrate команды, чтобы открыть запрос на вытягивание для каждого уникального репозитория, определенного в файле конфигурации:

gh actions-importer migrate circle-ci --circle-ci-project my-project-name --output-dir output/ --config-file-path config.yml --target-url https://github.com/my-org/my-repo

--include-from

Аргумент можно использовать --include-from с audit подкомандами.

Аргумент --include-from указывает файл, содержащий список репозиториев с разделителями строк для включения в аудит организации CircleCI. Все репозитории, не включенные в файл, исключены из аудита.

Например:

gh actions-importer audit circle-ci --output-dir ./output/ --include-from repositories.txt

Файл, предоставленный для этого параметра, должен быть списком репозиториев с разделителями строки, например:

repository_one
repository_two
repository_three

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

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

Конвейеры CircleCIGitHub ActionsСостояние
триггеры cron
  • on.schedule
Поддерживается
environment
  • env
  • jobs.<job_id>.env
  • jobs.<job_id>.steps.env
Поддерживается
исполнители
  • runs-on
Поддерживается
задания:
  • jobs
Поддерживается
задание
  • jobs.<job_id>
  • jobs.<job_id>.name
Поддерживается
матрицы
  • jobs.<job_id>.strategy
  • jobs.<job_id>.strategy.matrix
Поддерживается
parameters
  • env
  • workflow-dispatch.inputs
Поддерживается
steps
  • jobs.<job_id>.steps
Поддерживается
когда, если только не
  • jobs.<job_id>.if
Поддерживается
триггеры
  • on
Поддерживается
исполнители
  • container
  • services
Частично поддерживается
Шары
  • actions
Частично поддерживается
исполнители
  • self hosted runners
Не поддерживается
setupНет данныхНе поддерживается
версияНет данныхНе поддерживается

Дополнительные сведения о поддерживаемых сопоставлениях CircleCI и орфирования см. в репозиторииgithub/gh-actions-importer.

Сопоставление переменных среды

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

CircleCIGitHub Actions
CI$CI
CIRCLE_BRANCH${{ github.ref }}
CIRCLE_JOB${{ github.job }}
CIRCLE_PR_NUMBER${{ github.event.number }}
CIRCLE_PR_REPONAME${{ github.repository }}
CIRCLE_PROJECT_REPONAME${{ github.repository }}
CIRCLE_SHA1${{ github.sha }}
CIRCLE_TAG${{ github.ref }}
CIRCLE_USERNAME${{ github.actor }}
CIRCLE_WORKFLOW_ID${{ github.run_number }}
CIRCLE_WORKING_DIRECTORY${{ github.workspace }}
<< pipeline.id >>${{ github.workflow }}
<< pipeline.number >>${{ github.run_number }}
<< pipeline.project.git_url >>$GITHUB_SERVER_URL/$GITHUB_REPOSITORY
<< pipeline.project.type >>github
<< pipeline.git.tag >>${{ github.ref }}
<< pipeline.git.branch >>${{ github.ref }}
<< pipeline.git.revision >>${{ github.event.pull_request.head.sha }}
<< pipeline.git.base_revision >>${{ github.event.pull_request.base.sha }}

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