使用 GitHub Actions Importer 从 Bitbucket 管道迁移

法律通告

关于使用 GitHub Actions Importer 从 Bitbucket 管道迁移

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

先决条件

• 一个可在其中运行基于 Linux 的容器并可安装所需工具的环境。

  • Docker 已安装并正在运行。
  • 已安装 GitHub CLI。

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

限制

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

• 不支持专用 AWS ECR 中的映像。

• 不支持 Bitbucket 管道选项 size。 如果在 GitHub Actions 中需要更多运行器资源，请考虑使用 大型运行器。 有关详细信息，请参阅“使用较大运行器”。

• forecast 命令不支持详细描述作业队列时间的指标。

• 将 GitHub Actions always() 与以上步骤的 steps.<step_id>.conclusion 检查结合使用时。支持 Bitbucket after-scripts。 有关详细信息，请参阅“访问有关工作流运行的上下文信息”。

  下面是将 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. 安装 GitHub Actions Importer CLI 扩展：

   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 命令用于在使用 Bitbucket 管道和 GitHub 时为 GitHub Actions Importer 设置所需的凭据和选项。

1. 创建 GitHub personal access token (classic)。 有关详细信息，请参阅“管理个人访问令牌”。

   令牌必须具有 workflow 范围。

   创建令牌后，将其复制并保存在安全的位置供之后使用。

2. 为 Bitbucket 管道创建工作区访问令牌。 有关详细信息，请参阅 Bitbucket 文档中的工作区访问令牌权限。 令牌必须具有管道、项目和存储库的 read 作用域。

3. 在终端中，运行 GitHub Actions Importer configure CLI 命令：

   gh actions-importer configure
   

   configure 命令将提示你输入以下信息：

   • 对于“正在配置哪些 CI 提供程序?”，请使用箭头键选择 Bitbucket，按空格键将其选中，然后按 Enter。
   • 对于“Personal access token for GitHub”，输入前面创建的 personal access token (classic) 的值，然后按 Enter。
   • 对于“GitHub 实例的基 URL”，按 Enter 以接受默认值 (https://github.com)。
   • 对于“Personal access token for Bitbucket”，输入之前创建的工作区访问令牌的值，然后按 Enter。
   • 对于“Bitbucket 实例的基 URL”，请输入 Bitbucket 实例的 URL，然后按 Enter。

   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 Importer update CLI 命令以连接到 GitHub Packages Container registry，并确保容器映像已更新到最新版本：

   gh actions-importer update
   

   命令的输出应类似于以下内容：

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

对 Bitbucket 实例执行审核

可使用 audit 命令获取 Bitbucket 实例中的管道的概要视图。

audit 命令执行以下步骤。

1. 提取工作区的所有管道。
2. 将管道转换为其等效的 GitHub Actions 工作流。
3. 生成一个报告，汇总使用 GitHub Actions Importer 进行迁移的完成程度和复杂性。

运行审核命令

若要执行审核，请在终端中运行以下命令，将 :workspace 替换为要审核的 Bitbucket 工作区的名称。

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

（可选）可为 audit 命令提供选项 --project-key，以将结果限制为仅与项目关联的管道。

在下面的示例命令中，应将 :project_key 替换为要审核的项目的密钥。 可在工作区项目页上的 Bitbucket 中找到项目密钥。

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

检查审核结果

指定的输出目录中的文件包含审核结果。 有关审核结果的摘要，请参阅 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 中手动创建这些机密，才能使这些管道正常运行。 有关详细信息，请参阅“在 GitHub Actions 中使用机密”。
• “自托管运行器”是指在转换后的管道中引用的运行器（不是 GitHub 托管的运行器）的标签。 需要手动定义这些运行器，才能使这些管道正常运行。

文件

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

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

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

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

预测使用情况

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

运行预测命令

若要执行潜在的 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 托管的运行器的成本。
  • 此指标与你应在 GitHub Actions 中花费的成本相关。 这会因这些分钟所使用的硬件而异。 可以使用 GitHub Actions 定价计算器来估算成本。
• “并发作业”指标用于描述在任何给定时间运行的作业数量。

执行试运行迁移

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

运行试运行命令

若要执行将 Bitbucket 管道迁移到 GitHub Actions 的试运行，请在终端中运行以下命令，将 :workspace 替换为工作区的名称，并将 :repo 替换为 Bitbucket 中的存储库名称。

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

检查转换后的工作流

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

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

执行生产迁移

可以使用 migrate 命令转换 Bitbucket 管道，并使用等效的 GitHub Actions 工作流打开拉取请求。

运行迁移命令

若要将 Bitbucket 管道迁移到 GitHub Actions，请在终端中运行以下命令，替换以下值：

• 将值 target-url 替换为 GitHub 存储库的 URL。
• 将 :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：目标 GitHub 实例的 URL。 （例如 https://github.com）
• BITBUCKET_ACCESS_TOKEN：工作区访问令牌，其中包含管道、项目和存储库的读取范围。

这些环境变量可以在运行时由 GitHub Actions Importer 加载的 .env.local 文件中指定。 分发存档包含 .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 操作	状态
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 操作
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 shell 变量，并假定可用。 例如，${system.<variable.name>} 将转换为 $variable_name。 建议对此进行验证，以确保工作流正常运行。

法律通告

部分内容改编自 MIT 许可证下的 https://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.