Migrating from Bamboo with GitHub Actions Importer

About migrating from Bamboo with GitHub Actions Importer

The instructions below will guide you through configuring your environment to use GitHub Actions Importer to migrate Bamboo pipelines to GitHub Actions.

Prerequisites

A Bamboo account or organization with projects and pipelines that you want to convert to GitHub Actions workflows.
Bamboo version of 7.1.1 or greater.
Access to create a Bamboo personal access token for your account or organization.
一个可在其中运行基于 Linux 的容器并可安装所需工具的环境。
- Docker 已安装并正在运行。
- 已安装 GitHub CLI。
注意

GitHub Actions Importer 容器和 CLI 不需要安装在 CI 平台所在的同一服务器上。

Limitations

There are some limitations when migrating from Bamboo to GitHub Actions with GitHub Actions Importer:

GitHub Actions Importer relies on the YAML specification generated by the Bamboo Server to perform migrations. When Bamboo does not support exporting something to YAML, the missing information is not migrated.
Trigger conditions are unsupported. When GitHub Actions Importer encounters a trigger with a condition, the condition is surfaced as a comment and the trigger is transformed without it.
Bamboo Plans with customized settings for storing artifacts are not transformed. Instead, artifacts are stored and retrieved using the upload-artifact and download-artifact actions.
Disabled plans must be disabled manually in the GitHub UI. For more information, see Disabling and enabling a workflow.
Disabled jobs are transformed with a if: false condition which prevents it from running. You must remove this to re-enable the job.
Disabled tasks are not transformed because they are not included in the exported plan when using the Bamboo API.
Bamboo provides options to clean up build workspaces after a build is complete. These are not transformed because it is assumed GitHub-hosted runners or ephemeral self-hosted runners will automatically handle this.
The hanging build detection options are not transformed because there is no equivalent in GitHub Actions. The closest option is timeout-minutes on a job, which can be used to set the maximum number of minutes to let a job run. For more information, see GitHub Actions 的工作流语法.
Pattern match labeling is not transformed because there is no equivalent in GitHub Actions.
All artifacts are transformed into an actions/upload-artifact, regardless of whether they are shared or not, so they can be downloaded from any job in the workflow.
Permissions are not transformed because there is no suitable equivalent in GitHub Actions.
If the Bamboo version is between 7.1.1 and 8.1.1, project and plan variables will not be migrated.

Manual tasks

Certain Bamboo constructs must be migrated manually. These include:

Masked variables
Artifact expiry settings

Installing the GitHub Actions Importer CLI extension

安装 GitHub Actions Importer CLI 扩展：

Bash

gh extension install github/gh-actions-importer

gh extension install github/gh-actions-importer

验证是否已安装扩展：

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

Configuring credentials

The configure CLI command is used to set required credentials and options for GitHub Actions Importer when working with Bamboo and GitHub.

Create a GitHub personal access token (classic). For more information, see 管理个人访问令牌.

Your token must have the workflow scope.

After creating the token, copy it and save it in a safe location for later use.
Create a Bamboo personal access token. For more information, see Personal Access Tokens in the Bamboo documentation.

Your token must have the following permissions, depending on which resources will be transformed.

Resource Type View View Configuration Edit
Build Plan
Deployment Project
Deployment Environment

After creating the token, copy it and save it in a safe location for later use.
In your terminal, run the GitHub Actions Importer configure CLI command:
```
gh actions-importer configure
```
The configure command will prompt you for the following information:
- For "Which CI providers are you configuring?", use the arrow keys to select Bamboo, press Space to select it, then press Enter.
- For "Personal access token for GitHub", enter the value of the personal access token (classic) that you created earlier, and press Enter.
- For "Base url of the GitHub instance", enter the URL for 你的 GitHub Enterprise Server 实例, and press Enter.
- For "Personal access token for Bamboo", enter the value for the Bamboo personal access token that you created earlier, and press Enter.
- For "Base url of the Bamboo instance", enter the URL for your Bamboo Server or Bamboo Data Center instance, and press Enter.
An example of the configure command is shown below:
```
$ 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: http://github.com
✔ Personal access token for Bamboo: ********************
✔ Base url of the Bamboo instance: http://bamboo.example.com
Environment variables successfully updated.
```
In your terminal, run the GitHub Actions Importer update CLI command to connect to GitHub Packages Container registry and ensure that the container image is updated to the latest version:
```
gh actions-importer update
```
The output of the command should be similar to below:
```
Updating ghcr.io/actions-importer/cli:latest...
ghcr.io/actions-importer/cli:latest up-to-date
```

Perform an audit of Bamboo

You can use the audit command to get a high-level view of all projects in a Bamboo organization.

The audit command performs the following steps:

Fetches all of the projects defined in a Bamboo organization.
Converts each pipeline to its equivalent GitHub Actions workflow.
Generates a report that summarizes how complete and complex of a migration is possible with GitHub Actions Importer.

Running the audit command

To perform an audit of a Bamboo instance, run the following command in your terminal:

gh actions-importer audit bamboo --output-dir tmp/audit

Inspecting the audit results

指定的输出目录中的文件包含审核结果。有关审核结果的摘要，请参阅 audit_summary.md 文件。

审核摘要包含以下部分。

管道

“管道”部分包含有关由 GitHub Actions Importer 完成的转换率的概要统计信息。

下面列出了“管道”部分中可能出现的一些关键术语：

“成功”管道已将所有管道构造和单个项目自动转换为其 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 中手动创建这些机密，才能使这些管道正常运行。有关详细信息，请参阅“Using secrets in GitHub Actions”。
“自托管运行器”是指在转换后的管道中引用的运行器（不是 GitHub 托管的运行器）的标签。需要手动定义这些运行器，才能使这些管道正常运行。

文件

审核报告的最后一部分提供审核期间写入磁盘的所有文件的清单。

每个管道文件都包含审核中的各种文件，包括：

GitHub 中定义的原始管道。
用于转换管道的任何网络响应。
转换后的工作流文件。
可用于排查管道转换失败问题的堆栈跟踪。

此外，workflow_usage.csv 文件包含一个以逗号分隔的列表，其中列出了每个成功转换的管道所使用的所有操作、机密和运行器。这有助于确定哪些工作流使用哪些操作、机密或运行器，并且可用于进行安全评审。

Forecasting usage

You can use the forecast command to forecast potential GitHub Actions usage by computing metrics from completed pipeline runs in your Bamboo instance.

Running the forecast command

To perform a forecast of potential GitHub Actions usage, run the following command in your terminal. By default, GitHub Actions Importer includes the previous seven days in the forecast report.

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

Forecasting a project

To limit the forecast to the plans and deployments environments associated with a project, you can use the --project option, where the value is set to a build project key.

For example:

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

Inspecting the forecast report

The forecast_report.md file in the specified output directory contains the results of the forecast.

Listed below are some key terms that can appear in the forecast report:

The job count is the total number of completed jobs.
The pipeline count is the number of unique pipelines used.
Execution time describes the amount of time a runner spent on a job. This metric can be used to help plan for the cost of GitHub-hosted runners.
- This metric is correlated to how much you should expect to spend in GitHub Actions. This will vary depending on the hardware used for these minutes. You can use the GitHub Actions pricing calculator to estimate the costs.
Queue time metrics describe the amount of time a job spent waiting for a runner to be available to execute it.
Concurrent jobs metrics describe the amount of jobs running at any given time. This metric can be used to

Perform a dry-run migration of a Bamboo pipeline

You can use the dry-run command to convert a Bamboo pipeline to an equivalent GitHub Actions workflow. A dry-run creates the output files in a specified directory, but does not open a pull request to migrate the pipeline.

Running a dry-run migration for a build plan

To perform a dry run of migrating your Bamboo build plan to GitHub Actions, run the following command in your terminal, replacing :my_plan_slug with the plan's project and plan key in the format <projectKey>-<planKey> (for example: PAN-SCRIP).

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

Running a dry-run migration for a deployment project

To perform a dry run of migrating your Bamboo deployment project to GitHub Actions, run the following command in your terminal, replacing :my_deployment_project_id with the ID of the deployment project you are converting.

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

You can view the logs of the dry run and the converted workflow files in the specified output directory.

如果有任何 GitHub Actions Importer 无法自动转换的内容，例如未知生成步骤或部分成功管道，你可能需要创建自定义转换器来进一步自定义转换过程。有关详细信息，请参阅“Extending GitHub Actions Importer with custom transformers”。

Perform a production migration of a Bamboo pipeline

You can use the migrate command to convert a Bamboo pipeline and open a pull request with the equivalent GitHub Actions workflow.

Running the migrate command for a build plan

To migrate a Bamboo build plan to GitHub Actions, run the following command in your terminal, replacing the target-url value with the URL for your GitHub repository, and :my_plan_slug with the plan's project and plan key in the format <projectKey>-<planKey>.

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

The command's output includes the URL to the pull request that adds the converted workflow to your repository. An example of a successful output is similar to the following:

$ gh actions-importer migrate bamboo build --plan-slug :PROJECTKEY-PLANKEY --target-url http://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: 'http://github.com/octo-org/octo-repo/pull/1'

Running the migrate command for a deployment project

To migrate a Bamboo deployment project to GitHub Actions, run the following command in your terminal, replacing the target-url value with the URL for your GitHub repository, and :my_deployment_project_id with the ID of the deployment project you are converting.

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

The command's output includes the URL to the pull request that adds the converted workflow to your repository. An example of a successful output is similar to the following:

$ gh actions-importer migrate bamboo deployment --deployment-project-id 123 --target-url http://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: 'http://github.com/octo-org/octo-repo/pull/1'

检查拉取请求

migrate 命令成功运行的输出包含一个指向新拉取请求的链接，此拉取请求将转换后的工作流添加到存储库。

拉取请求的一些重要元素包括：

在拉取请求说明中，有一个名为“手动步骤”的部分，其中列出了在完成将管道迁移到 GitHub Actions 之前必须手动完成的步骤。例如，此部分可能会提供创建工作流中使用的任何机密。
转换后的工作流文件。选择拉取请求中的“Files changed”选项卡，查看将添加到 GitHub 仓库的工作流文件****。

检查完拉取请求后，可以将其合并以将工作流添加到 GitHub 仓库。

Reference

This section contains reference information on environment variables, optional arguments, and supported syntax when using GitHub Actions Importer to migrate from Bamboo.

Using environment variables

GitHub Actions Importer 使用环境变量进行身份验证配置。这些变量在使用 configure 命令执行配置过程时设置。有关详细信息，请参阅“配置凭据”部分。

GitHub Actions Importer uses the following environment variables to connect to your Bamboo instance:

GITHUB_ACCESS_TOKEN: The personal access token (classic) used to create pull requests with a converted workflow (requires repo and workflow scopes).
GITHUB_INSTANCE_URL: The URL to the target GitHub instance (for example, http://github.com).
BAMBOO_ACCESS_TOKEN: The Bamboo personal access token used to authenticate with your Bamboo instance.
BAMBOO_INSTANCE_URL: The URL to the Bamboo instance (for example, http://bamboo.example.com).

These environment variables can be specified in a .env.local file that is loaded by GitHub Actions Importer when it is run.

Optional arguments

有一些可选参数可以结合 GitHub Actions Importer 子命令使用来自定义迁移。

`--source-file-path`

You can use the --source-file-path argument with the dry-run or migrate subcommands.

By default, GitHub Actions Importer fetches pipeline contents from the Bamboo instance. The --source-file-path argument tells GitHub Actions Importer to use the specified source file path instead.

For example:

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`

You can use the --config-file-path argument with the audit, dry-run, and migrate subcommands.

By default, GitHub Actions Importer fetches pipeline contents from the Bamboo instance. The --config-file-path argument tells GitHub Actions Importer to use the specified source files instead.

Audit example

In this example, GitHub Actions Importer uses the specified YAML configuration file to perform an audit.

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

To audit a Bamboo instance using a config file, the config file must be in the following format, and each repository_slug must be unique:

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

Dry run example

In this example, GitHub Actions Importer uses the specified YAML configuration file as the source file to perform a dry run.

The repository slug is built using the --plan-slug option. The source file path is matched and pulled from the specified source file.

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

Supported syntax for Bamboo pipelines

The following table shows the type of properties that GitHub Actions Importer is currently able to convert.

Bamboo	GitHub Actions	Status
`environments`	`jobs`	Supported
`environments.<environment_id>`	`jobs.<job_id>`	Supported
`<job_id>.artifacts`	`jobs.<job_id>.steps.actions/upload-artifact`	Supported
`<job_id>.artifact-subscriptions`	`jobs.<job_id>.steps.actions/download-artifact`	Supported
`<job_id>.docker`	`jobs.<job_id>.container`	Supported
`<job_id>.final-tasks`	`jobs.<job_id>.steps.if`	Supported
`<job_id>.requirements`	`jobs.<job_id>.runs-on`	Supported
`<job_id>.tasks`	`jobs.<job_id>.steps`	Supported
`<job_id>.variables`	`jobs.<job_id>.env`	Supported
`stages`	`jobs.<job_id>.needs`	Supported
`stages.<stage_id>.final`	`jobs.<job_id>.if`	Supported
`stages.<stage_id>.jobs`	`jobs`	Supported
`stages.<stage_id>.jobs.<job_id>`	`jobs.<job_id>`	Supported
`stages.<stage_id>.manual`	`jobs.<job_id>.environment`	Supported
`triggers`	`on`	Supported
`dependencies`	`jobs.<job_id>.steps.<gh cli step>`	Partially Supported
`branches`	Not applicable	Unsupported
`deployment.deployment-permissions`	Not applicable	Unsupported
`environment-permissions`	Not applicable	Unsupported
`notifications`	Not applicable	Unsupported
`plan-permissions`	Not applicable	Unsupported
`release-naming`	Not applicable	Unsupported
`repositories`	Not applicable	Unsupported

For more information about supported Bamboo concept and plugin mappings, see the github/gh-actions-importer repository.

Environment variable mapping

GitHub Actions Importer uses the mapping in the table below to convert default Bamboo environment variables to the closest equivalent in 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 }}`

注意

Unknown variables are transformed to ${{ env.<variableName> }} and must be replaced or added under env for proper operation. For example, ${bamboo.jira.baseUrl} will become ${{ env.jira_baseUrl }}.

System Variables

System variables used in tasks are transformed to the equivalent bash shell variable and are assumed to be available. For example, ${system.<variable.name>} will be transformed to $variable_name. We recommend you verify this to ensure proper operation of the workflow.

Legal notice

部分内容改编自 MIT 许可证下的 http://github.com/github/gh-actions-importer/ ：

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.

Resource Type	View	View Configuration	Edit
Build Plan
Deployment Project
Deployment Environment

本文内容