Миграция с Bitbucket Pipelines с помощью импортера GitHub Actions

О миграции с Bitbucket Pipelines с помощью импортера GitHub Actions

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

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

• Среда, в которой можно запускать контейнеры на основе Linux и устанавливать необходимые средства.

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

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

  Примечание.

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

Ограничения

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

• Образы в частном ECR AWS не поддерживаются.

• Параметр size Bitbucket Pipelines не поддерживается.

• Метрики, подробные сведения о времени очереди заданий, не поддерживаются командой forecast .

• Bitbucket after-scripts поддерживается в GitHub Actionsalways() сочетании с проверкой steps.<step_id>.conclusion предыдущего шага. Дополнительные сведения см. в разделе Справочник по контекстам.

  Ниже приведен пример использования always() с steps.<step_id>.conclusion.

    - name: After Script 1
      run: |-
        echo "I'm after the script ran!"
        echo "We should be grouped!"
      id: after-script-1
      if: "${{ always() }}"
    - name: After Script 2
      run: |-
        echo "this is really the end"
        echo "goodbye, for now!"
      id: after-script-2
      if: "${{ steps.after-script-1.conclusion == 'success' && always() }}"
  

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

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

• Защищенный репозиторий, рабочая область и переменные развертывания
• Ключи SSH

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

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 при работе с Конвейерами Bitbucket и GitHub.

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

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

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

2. Создайте маркер доступа к рабочей области для конвейеров Bitbucket. Дополнительные сведения см. в разделе "Разрешения маркера доступа к рабочей области" в документации Bitbucket. Маркер должен иметь read область для конвейеров, проектов и репозиториев.

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

   gh actions-importer configure
   

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

   • Для вопроса «Каких провайдеров CI вы настраиваете?» используйте стрелки, чтобы выбрать Bitbucket, нажмите Space чтобы выбрать его, затем нажмите Enter.
   • Для "Personal access token for GitHub" введите значение того, personal access token (classic) что вы создали ранее, и нажмите Enter.
   • Для «Базового URL экземпляра GitHub» введите URL для экземпляр GitHub Enterprise Server, и нажмите Enter.
   • В поле "Personal access token For Bitbucket" введите созданный ранее маркер доступа к рабочей области и нажмите клавишу ВВОД.
   • В поле "Базовый URL-адрес экземпляра Bitbucket" введите URL-адрес для экземпляра Bitbucket и нажмите клавишу ВВОД.

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

   $ gh actions-importer configure
   ✔ Which CI providers are you configuring?: Bitbucket
   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 Bitbucket: ********************
   ✔ Base url of the Bitbucket instance: https://bitbucket.example.com
   Environment variables successfully updated.
   

4. В вашем терминале выполните GitHub Actions Importerupdate команду CLI, чтобы подключиться к GitHub PackagesContainer registry и убедиться, что образ контейнера обновлен до последней версии:

   gh actions-importer update
   

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

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

Выполнение аудита экземпляра Bitbucket

С помощью команды аудита можно получить высокоуровневое представление конвейеров в экземпляре Bitbucket.

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

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

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

Чтобы выполнить аудит, выполните следующую команду в терминале, заменив :workspace имя рабочей области Bitbucket на аудит.

gh actions-importer audit bitbucket --workspace :workspace --output-dir tmp/audit

При необходимости можно предоставить команду аудита, --project-key чтобы ограничить результаты только конвейерами, связанными с проектом.

В приведенном ниже примере команды :project_key следует заменить ключом проекта, который должен быть проверен. Ключи проекта можно найти на странице проектов рабочей области Bitbucket.

gh actions-importer audit bitbucket --workspace :workspace --project-key :project_key --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.
• Локальное средство выполнения ссылается на метку бегуна, на который ссылается преобразованный конвейер, который не является размещенным GitHubrunner. Необходимо вручную определить эти средства выполнения для правильной работы этих конвейеров.

Файлы

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

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

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

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

Прогнозирование использования

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

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

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

gh actions-importer forecast bitbucket --workspace :workspace --output-dir tmp/forecast_reports

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

Чтобы ограничить прогноз проекта, можно использовать этот --project-key параметр. Замените значение ключа :project_key проекта для прогнозируемого проекта.

gh actions-importer forecast bitbucket --workspace :workspace --project-key :project_key --output-dir tmp/forecast_reports

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

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

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

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

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

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

Выполнение команды dry-run

Чтобы выполнить сухой запуск миграции конвейера GitHub ActionsBitbucket в терминал, выполните следующую команду в терминале, заменив :workspace имя рабочей области и :repo имя репозитория в Bitbucket.

gh actions-importer dry-run bitbucket --workspace :workspace --repository :repo --output-dir tmp/dry-run

Проверка преобразованных рабочих процессов

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

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

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

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

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

Чтобы перенести конвейер GitHub ActionsBitbucket в, выполните следующую команду в терминале, заменив следующие значения.

• Замените target-url значение URL-адресом репозитория GitHub .
• Замените :repo именем репозитория в Bitbucket.
• Замените :workspace именем рабочей области.

gh actions-importer migrate bitbucket --workspace :workspace --repository :repo --target-url https://github.com/:owner/:repo --output-dir tmp/dry-run

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

gh actions-importer migrate bitbucket --workspace actions-importer --repository custom-trigger --target-url https://github.com/valet-dev-testing/demo-private --output-dir tmp/bitbucket
[2023-07-18 09:56:06] Logs: 'tmp/bitbucket/log/valet-20230718-165606.log'
[2023-07-18 09:56:24] Pull request: 'https://github.com/valet-dev-testing/demo-private/pull/55'

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

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

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

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

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

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

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

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

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

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

• GITHUB_ACCESS_TOKEN personal access token (classic): используется для создания запросов на вытягивание с преобразованным рабочим процессом (требуются repo и workflow области).
• GITHUB_INSTANCE_URL: URL целевой GitHub экземпляра. (например, https://github.com)
• BITBUCKET_ACCESS_TOKEN: маркер доступа к рабочей области с областями чтения для конвейера, проекта и репозитория.

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

Необязательные аргументы

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

--source-file-path

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

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

Например:

gh actions-importer dry-run bitbucket --workspace :workspace --repository :repo --output-dir tmp/dry-run --source-file-path path/to/my/pipeline/file.yml

--config-file-path

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

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

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

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

gh actions-importer audit bitbucket --workspace :workspace --output-dir tmp/audit --config-file-path "path/to/my/bitbucket/config.yml"

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

source_files:
  - repository_slug: repo_name
    path: path/to/one/source/file.yml
  - repository_slug: another_repo_name
    path: path/to/another/source/file.yml

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

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

Bitbucket	GitHub Actions	Состояние
after-script	jobs.<job_id>.steps[*]	Поддерживается
artifacts	actions/upload-artifact & download-artifact	Поддерживается
caches	actions/cache	Поддерживается
clone	actions/checkout	Поддерживается
condition	job.<job_id>.steps[*].run	Поддерживается
deployment	jobs.<job_id>.environment	Поддерживается
image	jobs.<job_id>.container	Поддерживается
max-time	jobs.<job_id>.steps[*].timeout-minutes	Поддерживается
options.docker	нет	Поддерживается
options.max-time	jobs.<job_id>.steps[*].timeout-minutes	Поддерживается
parallel	jobs.<job_id>	Поддерживается
pipelines.branches	on.push	Поддерживается
pipelines.custom	on.workflow_dispatch	Поддерживается
pipelines.default	on.push	Поддерживается
pipelines.pull-requests	on.pull_requests	Поддерживается
pipelines.tags	on.tags	Поддерживается
runs-on	jobs.<job_id>.runs-on	Поддерживается
script	job.<job_id>.steps[*].run	Поддерживается
services	jobs.<job_id>.service	Поддерживается
stage	jobs.<job_id>	Поддерживается
step	jobs.<job_id>.steps[*]	Поддерживается
trigger	on.workflow_dispatch	Поддерживается
fail-fast	нет	Не поддерживается
oidc	нет	Не поддерживается
options.size	нет	Не поддерживается
size	нет	Не поддерживается

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

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

Bitbucket	GitHub Actions
CI	true
BITBUCKET_BUILD_NUMBER	${{ github.run_number }}
BITBUCKET_CLONE_DIR	${{ github.workspace }}
BITBUCKET_COMMIT	${{ github.sha }}
BITBUCKET_WORKSPACE	${{ github.repository_owner }}
BITBUCKET_REPO_SLUG	${{ github.repository }}
BITBUCKET_REPO_UUID	${{ github.repository_id }}
BITBUCKET_REPO_FULL_NAME	${{ github.repository_owner }}/${{ github.repository }}
BITBUCKET_BRANCH	${{ github.ref }}
BITBUCKET_TAG	${{ github.ref }}
BITBUCKET_PR_ID	${{ github.event.pull_request.number }}
BITBUCKET_PR_DESTINATION_BRANCH	${{ github.event.pull_request.base.ref }}
BITBUCKET_GIT_HTTP_ORIGIN	${{ github.event.repository.clone_url }}
BITBUCKET_GIT_SSH_ORIGIN	${{ github.event.repository.ssh_url }}
BITBUCKET_EXIT_CODE	${{ job.status }}
BITBUCKET_STEP_UUID	${{ job.github_job }}
BITBUCKET_PIPELINE_UUID	${{ github.workflow }}
BITBUCKET_PROJECT_KEY	${{ github.repository_owner }}
BITBUCKET_PROJECT_UUID	${{ github.repository_owner }}
BITBUCKET_STEP_TRIGGERER_UUID	${{ github.actor_id }}
BITBUCKET_SSH_KEY_FILE	${{ github.workspace }}/.ssh/id_rsa
BITBUCKET_STEP_OIDC_TOKEN	Нет сопоставления
BITBUCKET_DEPLOYMENT_ENVIRONMENT	Нет сопоставления
BITBUCKET_DEPLOYMENT_ENVIRONMENT_UUID	Нет сопоставления
BITBUCKET_BOOKMARK	Нет сопоставления
BITBUCKET_PARALLEL_STEP	Нет сопоставления
BITBUCKET_PARALLEL_STEP_COUNT	Нет сопоставления

Системные переменные

Системные переменные, используемые в задачах, преобразуются в эквивалентную переменную оболочки Bash и считаются доступными. Например, ${system.<variable.name>} будет преобразован в $variable_name. Мы рекомендуем проверить это, чтобы обеспечить правильную работу рабочего процесса.

Юридическая информация

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