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

Узнайте, как GitHub Actions Importer автоматизировать миграцию конвейеров GitHub ActionsBamboo в .

## О миграции с Bamboo с помощью GitHub Actions Importer

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

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

* Учетная запись Bamboo или организация с проектами и конвейерами, которые необходимо преобразовать в GitHub Actions рабочие процессы.
* Бамбуковая версия 7.1.1 или более поздней.
* Доступ к созданию Бамбука personal access token для вашей учетной записи или организации.
* Среда, в которой можно запускать контейнеры на основе Linux и устанавливать необходимые средства.
  * Docker установлен [](https://docs.docker.com/get-docker/) и запущен.

  * [GitHub Интерфейс командной строки](https://cli.github.com) установлен.
  > \[!NOTE]
  > Контейнер GitHub Actions Importer и ИНТЕРФЕЙС командной строки не должны быть установлены на том же сервере, что и платформа CI.

### Ограничения

Существуют некоторые ограничения при переходе с Bamboo на GitHub ActionsGitHub Actions Importer:

* GitHub Actions Importer использует спецификацию YAML, созданную бамбуковым сервером для выполнения миграции. Если Bamboo не поддерживает экспорт чего-либо в YAML, отсутствующие сведения не переносятся.
* Условия триггера не поддерживаются. При GitHub Actions Importer обнаружении триггера с условием условие отображается как комментарий, и триггер преобразуется без него.
* Планы Bamboo с настраиваемыми параметрами для хранения артефактов не преобразуются. Вместо этого артефакты хранятся и извлекаются с помощью [`upload-artifact`](https://github.com/actions/upload-artifact) действий и [`download-artifact`](https://github.com/actions/download-artifact) действий.
* Планы для инвалидов необходимо отключить вручную в интерфейсе GitHub. Дополнительные сведения см. в разделе [Отключение и включение рабочего процесса](/ru/actions/how-tos/manage-workflow-runs/disable-and-enable-workflows).
* Отключенные задания преобразуются с условием `if: false` , которое предотвращает его выполнение. Необходимо удалить это, чтобы повторно включить задание.
* Отключенные задачи не преобразуются, так как они не включены в экспортируемый план при использовании API Bamboo.
* Bamboo предоставляет варианты очистки рабочих областей сборки после завершения сборки. Они не трансформируются, потому что предполагается, что раннеры на GitHub или эфемерные самостоятельные раннеры будут автоматически этим заниматься.
* Параметры обнаружения зависания сборки не преобразуются, так как в ней нет эквивалента GitHub Actions. Ближайшим вариантом является `timeout-minutes` задание, которое можно использовать для установки максимального количества минут, чтобы позволить выполнению задания. Дополнительные сведения см. в разделе [Синтаксис рабочего процесса для GitHub Actions](/ru/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idtimeout-minutes).
* Метка сопоставления шаблонов не преобразуется, так как в ней нет эквивалента GitHub Actions.
* Все артефакты преобразуются в `actions/upload-artifact`объект независимо от того, являются `shared` ли они или нет, поэтому их можно скачать из любого задания в рабочем процессе.
* Разрешения не преобразуются, так как в ней нет подходящего эквивалента GitHub Actions.
* Если бамбуковая версия составляет от 7.1.1 до 8.1.1, переменные проекта и плана не будут перенесены.

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

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

* Маскированные переменные
* Параметры истечения срока действия артефактов

## Установка 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 при работе с Bamboo и 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. Создание бамбука personal access token. Дополнительные сведения см [Personal Access Tokens](https://confluence.atlassian.com/bamboo/personal-access-tokens-976779873.html) . в документации по Bamboo.

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

   | Тип ресурса          |                                                                                                                                                      Представления                                                                                                                                                      |                                                                                                                                                                                                        Просмотр конфигурации                                                                                                                                                                                                       |                                                                                                                                                                                                              Изменить                                                                                                                                                                                                              |
   | :------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
   | План сборки          | <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-check" aria-label="Required" role="img"><path d="M13.78 4.22a.75.75 0 0 1 0 1.06l-7.25 7.25a.75.75 0 0 1-1.06 0L2.22 9.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L6 10.94l6.72-6.72a.75.75 0 0 1 1.06 0Z"></path></svg> |                                                       <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-check" aria-label="Required" role="img"><path d="M13.78 4.22a.75.75 0 0 1 0 1.06l-7.25 7.25a.75.75 0 0 1-1.06 0L2.22 9.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L6 10.94l6.72-6.72a.75.75 0 0 1 1.06 0Z"></path></svg>                                                      |                                                       <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-check" aria-label="Required" role="img"><path d="M13.78 4.22a.75.75 0 0 1 0 1.06l-7.25 7.25a.75.75 0 0 1-1.06 0L2.22 9.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L6 10.94l6.72-6.72a.75.75 0 0 1 1.06 0Z"></path></svg>                                                      |
   | Проект развертывания | <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-check" aria-label="Required" role="img"><path d="M13.78 4.22a.75.75 0 0 1 0 1.06l-7.25 7.25a.75.75 0 0 1-1.06 0L2.22 9.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L6 10.94l6.72-6.72a.75.75 0 0 1 1.06 0Z"></path></svg> |                                                       <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-check" aria-label="Required" role="img"><path d="M13.78 4.22a.75.75 0 0 1 0 1.06l-7.25 7.25a.75.75 0 0 1-1.06 0L2.22 9.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L6 10.94l6.72-6.72a.75.75 0 0 1 1.06 0Z"></path></svg>                                                      | <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-x" aria-label="Not required" role="img"><path d="M3.72 3.72a.75.75 0 0 1 1.06 0L8 6.94l3.22-3.22a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l3.22 3.22a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-3.22 3.22a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L6.94 8 3.72 4.78a.75.75 0 0 1 0-1.06Z"></path></svg> |
   | Среда развертывания  | <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-check" aria-label="Required" role="img"><path d="M13.78 4.22a.75.75 0 0 1 0 1.06l-7.25 7.25a.75.75 0 0 1-1.06 0L2.22 9.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018L6 10.94l6.72-6.72a.75.75 0 0 1 1.06 0Z"></path></svg> | <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-x" aria-label="Not required" role="img"><path d="M3.72 3.72a.75.75 0 0 1 1.06 0L8 6.94l3.22-3.22a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l3.22 3.22a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-3.22 3.22a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L6.94 8 3.72 4.78a.75.75 0 0 1 0-1.06Z"></path></svg> | <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-x" aria-label="Not required" role="img"><path d="M3.72 3.72a.75.75 0 0 1 1.06 0L8 6.94l3.22-3.22a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l3.22 3.22a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-3.22 3.22a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L6.94 8 3.72 4.78a.75.75 0 0 1 0-1.06Z"></path></svg> |

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

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

   ```shell
   gh actions-importer configure
   ```

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

   * Для вопроса «Каких провайдеров CI вы настраиваете?» используйте стрелки, чтобы выбрать `Bamboo`, нажмите <kbd>Space</kbd> чтобы выбрать его, затем нажмите <kbd>Enter</kbd>.
   * Для "Personal access token for GitHub" введите значение того, personal access token (classic) что вы создали ранее, и нажмите <kbd>Enter</kbd>.
   * Для «Базового URL экземпляра GitHub» нажмите <kbd>Enter</kbd> , чтобы принять значение по умолчанию (`https://github.com`).
   * В поле "Personal access token For Bamboo" введите значение для созданного ранее бамбука personal access token и нажмите клавишу <kbd>ВВОД</kbd>.
   * В поле "Базовый URL-адрес экземпляра Бамбука" введите URL-адрес для экземпляра Bamboo Server или Bamboo Data Center и нажмите клавишу <kbd>ВВОД</kbd>.

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

   ```shell
   $ gh actions-importer configure
   ✔ Which CI providers are you configuring?: Bamboo
   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 Bamboo: ********************
   ✔ Base url of the Bamboo instance: https://bamboo.example.com
   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
   ```

## Аудит Бамбука

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

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

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

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

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

```shell
gh actions-importer audit bamboo --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 использование, вычисляя метрики из завершенного конвейера в экземпляре Bamboo.

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

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

```shell
gh actions-importer forecast bamboo --output-dir tmp/forecast_reports
```

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

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

Например:

```shell
gh actions-importer forecast bamboo --project PAN --output-dir tmp/forecast_reports
```

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

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

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

* Число **заданий** — общее количество завершенных заданий.
* Число **конвейеров — это количество уникальных используемых конвейеров** .
* **Время** выполнения описывает время выполнения, затраченное на задание. Этот показатель помогает планировать стоимость GitHub-hosted runners.
  * Этот показатель коррелирует с тем, сколько вы должны ожидать в GitHub Actions. Это зависит от оборудования, используемого в эти минуты. Вы можете использовать [GitHub Actions калькулятор ценообразования](https://github.com/pricing/calculator) , чтобы оценить затраты.
* **Метрики времени** очереди описывают время, затраченное на выполнение задания, ожидающего доступности средства выполнения.
* **Метрики параллельных заданий** описывают количество заданий, выполняемых в любое время. Эту метрику можно использовать для

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

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

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

Чтобы выполнить сухой запуск миграции плана GitHub Actionsсборки Bamboo, выполните следующую команду в терминале, заменив `:my_plan_slug` проект плана и ключ плана в формате `<projectKey>-<planKey>` (например: `PAN-SCRIP`).

```shell
gh actions-importer dry-run bamboo build --plan-slug :my_plan_slug --output-dir tmp/dry-run
```

### Выполнение миграции с сухим запуском для проекта развертывания

Чтобы выполнить сухой запуск миграции проекта GitHub Actionsразвертывания Bamboo, выполните следующую команду в терминале, заменив `:my_deployment_project_id` идентификатор преобразованного проекта развертывания.

```shell
gh actions-importer dry-run bamboo deployment --deployment-project-id :my_deployment_project_id --output-dir tmp/dry-run
```

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

Если нет ничего, что GitHub Actions Importer не удалось преобразовать автоматически, например неизвестные шаги сборки или частично успешный конвейер, может потребоваться создать настраиваемые преобразователи для дальнейшей настройки процесса преобразования. Дополнительные сведения см. в разделе [Расширение импортера GitHub Actions с пользовательскими трансформерами](/ru/actions/reference/github-actions-importer/custom-transformers).

## Выполнение производственной миграции конвейера Bamboo

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

### Выполнение команды миграции для плана сборки

Чтобы перенести план GitHub Actionsсборки Bamboo, выполните следующую команду в терминале, заменив `target-url` значение URL-адресом GitHub репозитория и `:my_plan_slug` ключом проекта плана в формате `<projectKey>-<planKey>`.

```shell
gh actions-importer migrate bamboo build --plan-slug :my_plan_slug --target-url :target_url --output-dir tmp/migrate
```

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

```shell
$ gh actions-importer migrate bamboo build --plan-slug :PROJECTKEY-PLANKEY --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate
[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'
```

### Выполнение команды миграции для проекта развертывания

Чтобы перенести проект GitHub Actionsразвертывания Bamboo, выполните следующую команду в терминале, заменив `target-url` значение URL-адресом GitHub репозитория и `:my_deployment_project_id` идентификатором преобразованного проекта развертывания.

```shell
gh actions-importer migrate bamboo deployment --deployment-project-id :my_deployment_project_id --target-url :target_url --output-dir tmp/migrate
```

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

```shell
$ gh actions-importer migrate bamboo deployment --deployment-project-id 123 --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate
[2023-04-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20230420-014033.log'
[2023-04-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'
```

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

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

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

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

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

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

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

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

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

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

* `GITHUB_ACCESS_TOKEN`: Используется personal access token (classic) для создания пулл-запросов с конвертированным рабочим процессом (требования `repo` и `workflow` область объёмов).
* `GITHUB_INSTANCE_URL`: URL целевого GitHub экземпляра (например, `https://github.com`).
* `BAMBOO_ACCESS_TOKEN`: Бамбук personal access token , используемый для проверки подлинности с помощью экземпляра Bamboo.
* `BAMBOO_INSTANCE_URL`: URL-адрес экземпляра Bamboo (например, `https://bamboo.example.com`).

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

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

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

#### `--source-file-path`

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

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

Например:

```shell
gh actions-importer dry-run bamboo build --plan-slug IN-COM -o tmp/bamboo --source-file-path ./path/to/my/bamboo/file.yml
```

#### `--config-file-path`

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

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

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

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

```bash
gh actions-importer audit bamboo -o tmp/bamboo --config-file-path "./path/to/my/bamboo/config.yml"
```

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

```yaml
source_files:
  - repository_slug: IN/COM
    path: path/to/one/source/file.yml
  - repository_slug: IN/JOB
    path: path/to/another/source/file.yml
```

##### Пример сухого запуска

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

Слизь репозитория создается с помощью `--plan-slug` параметра. Путь к исходному файлу сопоставляется и извлекается из указанного исходного файла.

```bash
gh actions-importer dry-run bamboo build --plan-slug IN-COM -o tmp/bamboo --config-file-path "./path/to/my/bamboo/config.yml"
```

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

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

| Bamboo                              | GitHub Actions                                  |               Состояние |
| :---------------------------------- | :---------------------------------------------- | ----------------------: |
| `environments`                      | `jobs`                                          |          Поддерживается |
| `environments.<environment_id>`     | `jobs.<job_id>`                                 |          Поддерживается |
| `<job_id>.artifacts`                | `jobs.<job_id>.steps.actions/upload-artifact`   |          Поддерживается |
| `<job_id>.artifact-subscriptions`   | `jobs.<job_id>.steps.actions/download-artifact` |          Поддерживается |
| `<job_id>.docker`                   | `jobs.<job_id>.container`                       |          Поддерживается |
| `<job_id>.final-tasks`              | `jobs.<job_id>.steps.if`                        |          Поддерживается |
| `<job_id>.requirements`             | `jobs.<job_id>.runs-on`                         |          Поддерживается |
| `<job_id>.tasks`                    | `jobs.<job_id>.steps`                           |          Поддерживается |
| `<job_id>.variables`                | `jobs.<job_id>.env`                             |          Поддерживается |
| `stages`                            | `jobs.<job_id>.needs`                           |          Поддерживается |
| `stages.<stage_id>.final`           | `jobs.<job_id>.if`                              |          Поддерживается |
| `stages.<stage_id>.jobs`            | `jobs`                                          |          Поддерживается |
| `stages.<stage_id>.jobs.<job_id>`   | `jobs.<job_id>`                                 |          Поддерживается |
| `stages.<stage_id>.manual`          | `jobs.<job_id>.environment`                     |          Поддерживается |
| `triggers`                          | `on`                                            |          Поддерживается |
| `dependencies`                      | `jobs.<job_id>.steps.<gh cli step>`             | Частично поддерживается |
| `branches`                          | Нет данных                                      |       Не поддерживается |
| `deployment.deployment-permissions` | Нет данных                                      |       Не поддерживается |
| `environment-permissions`           | Нет данных                                      |       Не поддерживается |
| `notifications`                     | Нет данных                                      |       Не поддерживается |
| `plan-permissions`                  | Нет данных                                      |       Не поддерживается |
| `release-naming`                    | Нет данных                                      |       Не поддерживается |
| `repositories`                      | Нет данных                                      |       Не поддерживается |

Дополнительные сведения о поддерживаемых концепциях Bamboo и сопоставлениях подключаемых модулей см. в репозитории[`github/gh-actions-importer`](https://github.com/github/gh-actions-importer/blob/main/docs/bamboo/index.md).

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

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

| Bamboo                                           | GitHub Actions                                                                        |
| :----------------------------------------------- | :------------------------------------------------------------------------------------ |
| `bamboo.agentId`                                 | `${{ github.runner_name }}`                                                           |
| `bamboo.agentWorkingDirectory`                   | `${{ github.workspace }}`                                                             |
| `bamboo.buildKey`                                | `${{ github.workflow }}-${{ github.job }}`                                            |
| `bamboo.buildNumber`                             | `${{ github.run_id }}`                                                                |
| `bamboo.buildPlanName`                           | `${{ github.repository }}-${{ github.workflow }}-${{ github.job }`                    |
| `bamboo.buildResultKey`                          | `${{ github.workflow }}-${{ github.job }}-${{ github.run_id }}`                       |
| `bamboo.buildResultsUrl`                         | `${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}` |
| `bamboo.build.working.directory`                 | `${{ github.workspace }}`                                                             |
| `bamboo.deploy.project`                          | `${{ github.repository }}`                                                            |
| `bamboo.ManualBuildTriggerReason.userName`       | `${{ github.actor }}`                                                                 |
| `bamboo.planKey`                                 | `${{ github.workflow }}`                                                              |
| `bamboo.planName`                                | `${{ github.repository }}-${{ github.workflow }}`                                     |
| `bamboo.planRepository.branchDisplayName`        | `${{ github.ref }}`                                                                   |
| `bamboo.planRepository.<position>.branch`        | `${{ github.ref }}`                                                                   |
| `bamboo.planRepository.<position>.branchName`    | `${{ github.ref }}`                                                                   |
| `bamboo.planRepository.<position>.name`          | `${{ github.repository }}`                                                            |
| `bamboo.planRepository.<position>.repositoryUrl` | `${{ github.server }}/${{ github.repository }}`                                       |
| `bamboo.planRepository.<position>.revision`      | `${{ github.sha }}`                                                                   |
| `bamboo.planRepository.<position>.username`      | `${{ github.actor}}`                                                                  |
| `bamboo.repository.branch.name`                  | `${{ github.ref }}`                                                                   |
| `bamboo.repository.git.branch`                   | `${{ github.ref }}`                                                                   |
| `bamboo.repository.git.repositoryUrl`            | `${{ github.server }}/${{ github.repository }}`                                       |
| `bamboo.repository.pr.key`                       | `${{ github.event.pull_request.number }}`                                             |
| `bamboo.repository.pr.sourceBranch`              | `${{ github.event.pull_request.head.ref }}`                                           |
| `bamboo.repository.pr.targetBranch`              | `${{ github.event.pull_request.base.ref }}`                                           |
| `bamboo.resultsUrl`                              | `${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}` |
| `bamboo.shortJobKey`                             | `${{ github.job }}`                                                                   |
| `bamboo.shortJobName`                            | `${{ github.job }}`                                                                   |
| `bamboo.shortPlanKey`                            | `${{ github.workflow }}`                                                              |
| `bamboo.shortPlanName`                           | `${{ github.workflow }}`                                                              |

> \[!NOTE]
> Неизвестные переменные преобразуются `${{ env.<variableName> }}`в и должны быть заменены или добавлены для `env` правильной операции. Например, `${bamboo.jira.baseUrl}` станет `${{ env.jira_baseUrl }}`.

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

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

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

Части были адаптированы в соответствии с <https://github.com/github/gh-actions-importer/> лицензией MIT:

```text
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.
```