使用 GitHub Actions 导入程序从 CircleCI 迁移

法律通告

关于使用 GitHub Actions 导入程序从 CircleCI 迁移

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

先决条件

• 具有要转换为 GitHub Actions 工作流的项目和管道的 CircleCI 帐户或组织。
• 为帐户或组织创建 CircleCI 个人 API 令牌的访问权限。
• 一个可在其中运行基于 Linux 的容器并可安装所需工具的环境。

  • Docker 已安装并正在运行。

  • 已安装 GitHub CLI。

  Note

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

限制

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

• 不支持在不同工作流的作业之间自动缓存。
• 仅当使用 CircleCI 组织帐户时才支持 audit 命令。 dry-run 和 migrate 命令可用于 CircleCI 组织或用户帐户。

手动任务

某些 CircleCI 构造必须手动迁移。 其中包括：

• 上下文
• 项目级环境变量
• 未知的作业属性
• 未知 orb

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

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

   令牌必须具有 workflow 范围。

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

2. 创建 CircleCI 个人 API 令牌。 有关详细信息，请参阅 CircleCI 文档中的管理 API 令牌。

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

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

   gh actions-importer configure
   

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

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

   configure 命令的示例如下所示：

   $ gh actions-importer configure
   ✔ Which CI providers are you configuring?: CircleCI
   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 CircleCI: ********************
   ✔ Base url of the CircleCI instance: https://circleci.com
   ✔ CircleCI organization name: mycircleciorganization
   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
   

对 CircleCI 执行审核

可以使用 audit 命令获取 CircleCI 组织中所有项目的概要视图。

audit 命令执行以下步骤：

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

运行审核命令

若要对 CircleCI 组织执行审核，请在终端中运行以下命令：

gh actions-importer audit circle-ci --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 文件包含一个以逗号分隔的列表，其中列出了每个成功转换的管道所使用的所有操作、机密和运行器。 这有助于确定哪些工作流使用哪些操作、机密或运行器，并且可用于进行安全评审。

预测可能的 GitHub Actions 使用情况

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

运行预测命令

若要预测可能的 GitHub Actions 使用情况，请在终端中运行以下命令。 默认情况下，GitHub Actions Importer 在预测报告中包括过去七天的信息。

gh actions-importer forecast circle-ci --output-dir tmp/forecast_reports

检查预测报告

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

下面列出了预测报告中可能出现的一些关键术语：

• “作业计数”是已完成作业的总数。

• “管道计数”是使用的独立管道数。

• “执行时间”指的是运行器在一项作业中所用的时间。 此指标可用于帮助计划 GitHub 托管的运行器的成本。

  此指标与你应在 GitHub Actions 中花费的成本相关。 这会因这些分钟所使用的硬件而异。 可以使用 GitHub Actions 定价计算器来估算成本。

• “队列时间”指标用于描述等待运行器可用于执行作业的时间。

• “并发作业”指标用于描述在任何给定时间运行的作业数量。 此指标可用于定义应配置的运行器数。

此外，这些指标是针对 CircleCI 中的每个运行器队列定义的。 这在混合使用托管/自承载运行器或者高规格/低规格的计算机时特别有用，这样就可以查看特定于不同类型运行器的指标。

执行 CircleCI 管道的试运行迁移

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

若要执行到 GitHub Actions 的 CircleCI 项目试运行迁移，请在终端中运行以下命令，将 my-circle-ci-project 替换为 CircleCI 项目的名称。

gh actions-importer dry-run circle-ci --output-dir tmp/dry-run --circle-ci-project my-circle-ci-project

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

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

执行 CircleCI 管道的生产迁移

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

运行迁移命令

若要将 CircleCI 管道迁移到 GitHub Actions，请在终端中运行以下命令，将 target-url 值替换为 GitHub 存储库的 URL，并将 my-circle-ci-project 替换为 CircleCI 项目的名称。

gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project

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

$ gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project
[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 命令成功运行的输出包含一个指向新拉取请求的链接，此拉取请求将转换后的工作流添加到存储库。

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

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

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

参考

本部分包含使用 GitHub Actions Importer 从 CircleCI 迁移时涉及的环境变量、可选参数和支持的语法的参考信息。

使用环境变量

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

GitHub Actions Importer 使用以下环境变量连接到 CircleCI 实例：

• GITHUB_ACCESS_TOKEN：用于通过转换后的工作流创建拉取请求的 personal access token (classic)（需要 repo 和 workflow 范围）。
• GITHUB_INSTANCE_URL：目标 GitHub 实例的 URL（例如 https://github.com）。
• CIRCLE_CI_ACCESS_TOKEN：用于对 CircleCI 实例进行身份验证的 CircleCI 个人 API 令牌。
• CIRCLE_CI_INSTANCE_URL：CircleCI 实例的 URL（例如 https://circleci.com）。 如果未设置变量，则 https://circleci.com 用作默认值。
• CIRCLE_CI_ORGANIZATION：CircleCI 实例的组织名称。
• CIRCLE_CI_PROVIDER：管道源文件的存储位置（例如 github）。 目前，仅支持 GitHub。
• CIRCLE_CI_SOURCE_GITHUB_ACCESS_TOKEN（可选）：用于对源 GitHub 实例进行身份验证的 personal access token (classic)（需要 repo 范围）。 如果未提供，则改用 GITHUB_ACCESS_TOKEN 的值。
• CIRCLE_CI_SOURCE_GITHUB_INSTANCE_URL（可选）：源 GitHub 实例的 URL。 如果未提供，则改用 GITHUB_INSTANCE_URL 的值。

这些环境变量可以在 GitHub Actions Importer 运行时加载的 .env.local 文件中指定。

可选自变量

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

--source-file-path

可以将 --source-file-path 参数与 forecast、dry-run 或 migrate 子命令结合使用。

默认情况下，GitHub Actions Importer 从源代码管理中提取管道内容。 --source-file-path 参数指示 GitHub Actions Importer 改用指定的源文件路径。

例如：

gh actions-importer dry-run circle-ci --output-dir ./output/ --source-file-path ./path/to/.circleci/config.yml

如果要在运行 forecast 子命令时提供多个源文件，可以在文件路径值中使用模式匹配。 例如，gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json 为 GitHub Actions Importer 提供与 ./tmp/previous_forecast/jobs/*.json 文件路径匹配的任何源文件。

--config-file-path

可以将 --config-file-path 参数与 audit、dry-run 和 migrate 子命令结合使用。

默认情况下，GitHub Actions Importer 从源代码管理中提取管道内容。 --config-file-path 参数指示 GitHub Actions Importer 改用指定的源文件。

--config-file-path 参数还可用于指定应将已转换可复合操作迁移到哪个存储库。

“审核”示例

在此示例中，GitHub Actions Importer 使用指定的 YAML 配置文件来执行审核。

gh actions-importer audit circle-ci --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml

若要使用配置文件审核 CircleCI 实例，配置文件必须采用以下格式，并且每个 repository_slug 都必须是唯一的：

source_files:
  - repository_slug: circle-org-name/circle-project-name
    path: path/to/.circleci/config.yml
  - repository_slug: circle-org-name/some-other-circle-project-name
    path: path/to/.circleci/config.yml

试运行示例

在此示例中，GitHub Actions Importer 使用指定的 YAML 配置文件作为源文件来执行试运行。

通过匹配配置文件中的 repository_slug 与 --circle-ci-organization 和 --circle-ci-project 选项的值来选择管道。 然后，使用 path 拉取指定的源文件。

gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml

指定已转换复合操作的存储库

GitHub Actions Importer 使用提供给 --config-file-path 参数的 YAML 文件来确定将已转换复合操作迁移到的存储库。

首先，应在不使用 --config-file-path 参数的情况下运行审核：

gh actions-importer audit circle-ci --output-dir ./output/

此命令的输出将包含名为 config.yml 的文件，其中包含由 GitHub Actions Importer 转换的所有复合操作的列表。 例如，config.yml 文件可能包含以下内容：

composite_actions:
  - name: my-composite-action.yml
    target_url: https://github.com/octo-org/octo-repo
    ref: main

可以使用此文件指定应将可重用工作流或复合操作添加到哪个存储库和参考。 然后，可以使用 --config-file-path 参数将 config.yml 文件提供给 GitHub Actions Importer。 例如，可以在运行 migrate 命令时使用此文件，为配置文件中定义的每个唯一存储库打开拉取请求：

gh actions-importer migrate circle-ci --circle-ci-project my-project-name --output-dir output/ --config-file-path config.yml --target-url https://github.com/my-org/my-repo

--include-from

可以将 --include-from 参数与 audit 子命令结合使用。

--include-from 指定一个包含行分隔的列表的文件，列表中列出了要包含在 CircleCI 组织审核中的存储库。 任何未包含在文件中的存储库都将不纳入审核。

例如：

gh actions-importer audit circle-ci --output-dir ./output/ --include-from repositories.txt

为此参数提供的文件必须是行分隔的存储库列表，例如：

repository_one
repository_two
repository_three

CircleCI 管道支持的语法

下表显示了 GitHub Actions Importer 当前能够转换的属性类型。

CircleCI 管道	GitHub 操作	状态
cron 触发器	on.schedule	支持
环境	env jobs.<job_id>.env jobs.<job_id>.steps.env	支持
执行程序	runs-on	支持
jobs	jobs	支持
作业 (job)	jobs.<job_id> jobs.<job_id>.name	支持
矩形图	jobs.<job_id>.strategy jobs.<job_id>.strategy.matrix	支持
parameters	env workflow-dispatch.inputs	支持
steps	jobs.<job_id>.steps	支持
when、unless	jobs.<job_id>.if	支持
触发器	on	支持
执行程序	container services	部分支持
orb	actions	部分支持
执行程序	self hosted runners	不支持
安装	不适用	不支持
版本	不适用	不支持

有关支持的 CircleCI 概念和 orb 映射的详细信息，请参阅 github/gh-actions-importer 存储库。

环境变量映射

GitHub Actions Importer 使用下表中的映射将默认 CircleCI 环境变量转换为 GitHub Actions 中最接近的等效项。

CircleCI	GitHub 操作
CI	$CI
CIRCLE_BRANCH	${{ github.ref }}
CIRCLE_JOB	${{ github.job }}
CIRCLE_PR_NUMBER	${{ github.event.number }}
CIRCLE_PR_REPONAME	${{ github.repository }}
CIRCLE_PROJECT_REPONAME	${{ github.repository }}
CIRCLE_SHA1	${{ github.sha }}
CIRCLE_TAG	${{ github.ref }}
CIRCLE_USERNAME	${{ github.actor }}
CIRCLE_WORKFLOW_ID	${{ github.run_number }}
CIRCLE_WORKING_DIRECTORY	${{ github.workspace }}
<< pipeline.id >>	${{ github.workflow }}
<< pipeline.number >>	${{ github.run_number }}
<< pipeline.project.git_url >>	$GITHUB_SERVER_URL/$GITHUB_REPOSITORY
<< pipeline.project.type >>	github
<< pipeline.git.tag >>	${{ github.ref }}
<< pipeline.git.branch >>	${{ github.ref }}
<< pipeline.git.revision >>	${{ github.event.pull_request.head.sha }}
<< pipeline.git.base_revision >>	${{ github.event.pull_request.base.sha }}

法律通告

部分内容改编自 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.