使用 GitHub Actions 导入器从 Bamboo 迁移

法律声明

关于使用 GitHub Actions Importer 从 Bamboo 迁移

以下说明将指导您配置环境以使用 GitHub Actions Importer 将 Bamboo 管道迁移到 GitHub Actions。

先决条件

一个 Bamboo 帐户或组织，其中包含您要转换为 GitHub Actions 工作流的项目和管道。
Bamboo 版本 7.1.1 或更高版本。
访问权限，以便为您的帐户或组织创建 Bamboo 个人访问令牌。
一个可以运行基于 Linux 的容器的环境，并且可以安装必要的工具。
- Docker 已安装并正在运行。
- GitHub CLI 已安装。
注意：GitHub Actions Importer 容器和 CLI 不需要安装在与您的 CI 平台相同的服务器上。

限制

使用 GitHub Actions Importer 从 Bamboo 迁移到 GitHub Actions 时，存在一些限制。

GitHub Actions Importer 依赖于 Bamboo 服务器生成的 YAML 规范来执行迁移。当 Bamboo 不支持将某些内容导出到 YAML 时，缺少的信息将不会迁移。
触发条件不受支持。当 GitHub Actions Importer 遇到带有条件的触发器时，该条件将作为注释显示，并且触发器将在没有条件的情况下进行转换。
带有自定义设置用于存储工件的 Bamboo 计划不会被转换。相反，工件将使用 upload-artifact 和 download-artifact 操作进行存储和检索。
必须在 GitHub UI 中手动禁用已禁用的计划。有关更多信息，请参阅“禁用和启用工作流”。
已禁用的作业将使用 if: false 条件进行转换，这将阻止其运行。您必须将其删除才能重新启用作业。
已禁用的任务不会被转换，因为它们在使用 Bamboo API 时不会包含在导出的计划中。
Bamboo 提供了在构建完成后清理构建工作区的选项。这些不会被转换，因为假设 GitHub 托管的运行器或短暂的自托管运行器将自动处理此问题。
挂起构建检测选项不会被转换，因为 GitHub Actions 中没有等效项。最接近的选项是作业上的 timeout-minutes，它可用于设置允许作业运行的最长时间。有关更多信息，请参阅“GitHub Actions 的工作流语法”。
模式匹配标签不会被转换，因为 GitHub Actions 中没有等效项。
所有工件都将转换为 actions/upload-artifact，无论它们是否为 shared，因此它们可以从工作流中的任何作业下载。
权限不会被转换，因为 GitHub Actions 中没有合适的等效项。
如果 Bamboo 版本介于 7.1.1 和 8.1.1 之间，则不会迁移项目和计划变量。

手动任务

某些 Bamboo 结构必须手动迁移。这些包括

屏蔽变量
工件过期设置

安装 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.

配置凭据

configure CLI 命令用于在使用 Bamboo 和 GitHub 时为 GitHub Actions Importer 设置所需的凭据和选项。

创建 GitHub 个人访问令牌（经典）。有关更多信息，请参阅“管理您的个人访问令牌”。

您的令牌必须具有workflow范围。

创建令牌后，将其复制并保存在安全位置以备后用。
创建 Bamboo 个人访问令牌。有关更多信息，请参阅 Bamboo 文档中的个人访问令牌。

您的令牌必须具有以下权限，具体取决于将要转换的资源。

资源类型查看查看配置编辑
构建计划
部署项目
部署环境

创建令牌后，将其复制并保存在安全位置以备后用。
在您的终端中，运行 GitHub Actions Importer configure CLI 命令
```
gh actions-importer configure
```
configure 命令将提示您输入以下信息
- 对于“您要配置哪些 CI 提供商？”，使用箭头键选择Bamboo，按空格键进行选择，然后按回车键。
- 对于“GitHub 的个人访问令牌”，输入您之前创建的个人访问令牌（经典）的值，然后按回车键。
- 对于“GitHub 实例的基地址”，按回车键接受默认值（https://github.com）。
- 对于“Bamboo 的个人访问令牌”，输入您之前创建的 Bamboo 个人访问令牌的值，然后按回车键。
- 对于“Bamboo 实例的基地址”，输入 Bamboo Server 或 Bamboo Data Center 实例的 URL，然后按回车键。
下面显示了configure 命令的示例
```
$ 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.
```
在您的终端中，运行 GitHub Actions Importer update CLI 命令以连接到 GitHub Packages Container 注册表并确保容器映像更新到最新版本
```
gh actions-importer update
```
命令的输出应类似于以下内容
```
Updating ghcr.io/actions-importer/cli:latest...
ghcr.io/actions-importer/cli:latest up-to-date
```

执行 Bamboo 的审计

您可以使用audit 命令获取 Bamboo 组织中所有项目的概览。

audit 命令执行以下步骤

获取 Bamboo 组织中定义的所有项目。
将每个管道转换为等效的 GitHub Actions 工作流程。
生成一份报告，总结使用 GitHub Actions Importer 可以实现的迁移的完整性和复杂性。

运行审核命令

要对 Bamboo 实例执行审核，请在您的终端中运行以下命令

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

检查审核结果

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

审核摘要包含以下部分。

管道

"管道" 部分包含有关 GitHub Actions 导入器完成的转换率的高级统计信息。

以下是 "管道" 部分中可能出现的一些关键术语

成功的管道已将 100% 的管道结构和单个项目自动转换为其 GitHub Actions 等效项。
部分成功的管道已将所有管道结构转换，但是，某些单个项目未自动转换为其 GitHub Actions 等效项。
不支持的管道是 GitHub Actions 导入器不支持的定义类型。
失败的管道在转换时遇到了致命错误。这可能是由于以下三种原因之一
- 管道配置错误，在 Bamboo 中无效。
- GitHub Actions 导入器在转换时遇到了内部错误。
- 由于网络响应不成功导致管道无法访问，这通常是由于凭据无效造成的。

构建步骤

"构建步骤" 部分概述了跨所有管道使用的单个构建步骤，以及 GitHub Actions 导入器自动转换了多少个步骤。

以下是 "构建步骤" 部分中可能出现的一些关键术语

已知构建步骤是指已自动转换为等效操作的步骤。
未知构建步骤是指未自动转换为等效操作的步骤。
不支持的构建步骤是指以下两种情况之一
- GitHub Actions 本质上不支持。
- 以与 GitHub Actions 不兼容的方式配置。
操作是已在转换后的工作流程中使用的操作列表。这对于以下情况可能很重要
- 如果您使用 GitHub Enterprise Server，则收集要同步到您的实例的操作列表。
- 定义组织级允许的操作列表。此操作列表是您的安全或合规团队可能需要审查的操作的综合列表。

手动任务

"手动任务" 部分概述了 GitHub Actions 导入器无法自动完成的任务，您必须手动完成。

以下是 "手动任务" 部分中可能出现的一些关键术语

秘密是指在转换后的管道中使用的存储库或组织级秘密。为了使这些管道正常运行，您必须在 GitHub Actions 中手动创建这些秘密。有关更多信息，请参阅 "在 GitHub Actions 中使用秘密。"。
自托管运行器是指在转换后的管道中引用的运行器标签，该标签不是 GitHub 托管的运行器。您需要手动定义这些运行器，才能使这些管道正常运行。

文件

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

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

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

此外，workflow_usage.csv 文件包含每个成功转换的管道使用的所有操作、秘密和运行器的逗号分隔列表。这对于确定哪些工作流程使用哪些操作、秘密或运行器很有用，并且可以用于执行安全审查。

预测使用情况

您可以使用 forecast 命令通过计算 Bamboo 实例中已完成的管道运行的指标来预测潜在的 GitHub Actions 使用情况。

运行预测命令

要执行潜在 GitHub Actions 使用情况的预测，请在您的终端中运行以下命令。默认情况下，GitHub Actions Importer 会在预测报告中包含前七天。

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

预测项目

要将预测限制为与项目关联的计划和部署环境，您可以使用 --project 选项，其中值设置为构建项目键。

例如

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

检查预测报告

指定输出目录中的 forecast_report.md 文件包含预测结果。

以下是预测报告中可能出现的一些关键术语

作业数 是已完成作业的总数。
管道数 是使用的唯一管道的数量。
执行时间 描述了运行器在作业上花费的时间。此指标可用于帮助规划 GitHub 托管运行器的成本。
- 此指标与您应该预期在 GitHub Actions 中花费的金额相关。这将根据用于这些分钟的硬件而有所不同。您可以使用 GitHub Actions 定价计算器来估算成本。
排队时间 指标描述了作业等待运行器可用以执行它所花费的时间。
并发作业 指标描述了在任何给定时间运行的作业数量。此指标可用于

执行 Bamboo 管道的试运行迁移

您可以使用 dry-run 命令将 Bamboo 管道转换为等效的 GitHub Actions 工作流程。试运行会在指定目录中创建输出文件，但不会打开拉取请求来迁移管道。

运行构建计划的试运行迁移

要执行将 Bamboo 构建计划迁移到 GitHub Actions 的试运行，请在您的终端中运行以下命令，将 :my_plan_slug 替换为计划的项目和计划键，格式为 <projectKey>-<planKey>（例如：PAN-SCRIP）。

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

运行部署项目的试运行迁移

要执行将 Bamboo 部署项目迁移到 GitHub Actions 的试运行，请在您的终端中运行以下命令，将 :my_deployment_project_id 替换为要转换的部署项目的 ID。

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

您可以在指定的输出目录中查看试运行的日志和转换后的工作流文件。

如果 GitHub Actions Importer 无法自动转换任何内容，例如未知的构建步骤或部分成功的管道，您可能需要创建自定义转换器来进一步自定义转换过程。有关更多信息，请参阅“使用自定义转换器扩展 GitHub Actions Importer”。

执行 Bamboo 管道的生产迁移

您可以使用 migrate 命令转换 Bamboo 管道并打开一个包含等效 GitHub Actions 工作流的拉取请求。

运行构建计划的 migrate 命令

要将 Bamboo 构建计划迁移到 GitHub Actions，请在您的终端中运行以下命令，将 target-url 值替换为 GitHub 存储库的 URL，并将 :my_plan_slug 替换为计划的项目和计划键，格式为 <projectKey>-<planKey>。

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

命令的输出包括将转换后的工作流添加到您的存储库的拉取请求的 URL。成功输出的示例类似于以下内容

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

运行部署项目的 migrate 命令

要将 Bamboo 部署项目迁移到 GitHub Actions，请在您的终端中运行以下命令，将 target-url 值替换为 GitHub 存储库的 URL，并将 :my_deployment_project_id 替换为要转换的部署项目的 ID。

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

命令的输出包括将转换后的工作流添加到您的存储库的拉取请求的 URL。成功输出的示例类似于以下内容

$ 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 命令执行配置过程时设置。有关更多信息，请参阅“配置凭据”部分。

GitHub Actions Importer 使用以下环境变量连接到您的 Bamboo 实例

GITHUB_ACCESS_TOKEN：用于创建包含转换后的工作流程的拉取请求的个人访问令牌（经典）（需要 repo 和 workflow 范围）。
GITHUB_INSTANCE_URL：目标 GitHub 实例的 URL（例如，https://github.com）。
BAMBOO_ACCESS_TOKEN：用于对您的 Bamboo 实例进行身份验证的 Bamboo 个人访问令牌。
BAMBOO_INSTANCE_URL：Bamboo 实例的 URL（例如，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 使用指定的源文件路径。

例如

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 配置文件执行审计。

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

要使用配置文件审计 Bamboo 实例，配置文件必须采用以下格式，并且每个 repository_slug 必须是唯一的

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 选项构建的。源文件路径与指定源文件中的路径匹配并从中提取。

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.<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`	支持
`阶段`	`jobs.<job_id>.needs`	支持
`stages.<stage_id>.final`	`jobs.<job_id>.if`	支持
`stages.<stage_id>.jobs`	`作业`	支持
`stages.<stage_id>.jobs.<job_id>`	`jobs.<job_id>`	支持
`stages.<stage_id>.manual`	`jobs.<job_id>.environment`	支持
`触发器`	`on`	支持
`依赖项`	`jobs.<job_id>.steps.<gh cli step>`	部分支持
`分支`	不适用	不支持
`deployment.deployment-permissions`	不适用	不支持
`environment-permissions`	不适用	不支持
`通知`	不适用	不支持
`plan-permissions`	不适用	不支持
`release-naming`	不适用	不支持
`存储库`	不适用	不支持

有关支持的 Bamboo 概念和插件映射的更多信息，请参阅 github/gh-actions-importer 存储库。

环境变量映射

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 }}`

注意： 未知的变量将转换为 ${{ env.<variableName> }}，必须在 env 下替换或添加，以确保正常运行。例如，${bamboo.jira.baseUrl} 将变为 ${{ env.jira_baseUrl }}。

系统变量

任务中使用的系统变量将转换为等效的 bash shell 变量，并假定可用。例如，${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.

资源类型	查看	查看配置	编辑
构建计划
部署项目
部署环境

使用 GitHub Actions Importer 从 Bamboo 迁移

本文内容