使用 GitHub Actions 导入器从 CircleCI 迁移

法律声明

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

以下说明将指导您配置环境，以便使用 GitHub Actions 导入器将 CircleCI 管道迁移到 GitHub Actions。

先决条件

• 一个 CircleCI 帐户或组织，其中包含您想要转换为 GitHub Actions 工作流的项目和管道。
• 访问权限，以便为您的帐户或组织创建 CircleCI 个人 API 令牌。
• 您可以运行基于 Linux 的容器的环境，并且可以安装必要的工具。

  • 已安装并运行 Docker。

  • 已安装GitHub CLI。

  注意

  GitHub Actions 导入器容器和 CLI 不需要安装在与您的 CI 平台相同的服务器上。

限制

使用 GitHub Actions 导入器从 CircleCI 迁移到 GitHub Actions 时，存在一些限制。

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

手动任务

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

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

安装 GitHub Actions 导入器 CLI 扩展

1. 安装 GitHub Actions 导入器 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 导入器所需的凭据和选项。

1. 创建一个 GitHub 个人访问令牌（经典版）。更多信息，请参见“管理您的个人访问令牌”。

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

   创建令牌后，将其复制并保存到安全位置以备后用。

2. 创建 CircleCI 个人 API 令牌。更多信息，请参见 CircleCI 文档中的管理 API 令牌。

   创建令牌后，将其复制并保存到安全位置以备后用。

3. 在您的终端中，运行 GitHub Actions 导入器configure CLI 命令

   gh actions-importer configure
   

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

   • 对于“您要配置哪些 CI 提供商？”，使用箭头键选择CircleCI，按Space选择它，然后按Enter。
   • 对于“GitHub 的个人访问令牌”，输入您之前创建的个人访问令牌（经典版）的值，然后按Enter。
   • 对于“GitHub 实例的基本 URL”，按Enter接受默认值 (https://github.com)。
   • 对于“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 导入器update CLI 命令以连接到 GitHub Packages 容器注册表并确保容器映像已更新到最新版本。

   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 导入器可以完成哪些迁移以及迁移的复杂程度。

运行审核命令

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

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

检查审核结果

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

审核摘要包含以下部分。

管道

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

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

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

构建步骤

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

下面列出了一些可能出现在“构建步骤”部分中的关键术语：

• 已知构建步骤是指已自动转换为等效操作的步骤。
• 未知构建步骤是指未自动转换为等效操作的步骤。
• 不支持的构建步骤是指：
  • GitHub Actions 本身根本不支持。
  • 配置方式与 GitHub Actions 不兼容。
• 操作是已转换工作流中使用的操作列表。这对于以下方面可能很重要：
  • 如果您使用的是 GitHub Enterprise Server，则收集要与您的实例同步的操作列表。
  • 定义组织级别的允许操作白名单。此操作列表是安全或合规团队可能需要审查的操作的全面列表。

手动任务

“手动任务”部分概述了 GitHub Actions 导入器无法自动完成且必须手动完成的任务。

下面列出了一些可能出现在“手动任务”部分中的关键术语：

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

文件

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

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

• 在 GitHub 中定义的原始管道。
• 用于转换管道的任何网络响应。
• 已转换的工作流文件。
• 可用于对失败的管道转换进行故障排除的堆栈跟踪。

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

预测潜在的 GitHub Actions 使用情况

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

运行预测命令

要预测潜在的 GitHub Actions 使用情况，请在您的终端中运行以下命令。默认情况下，GitHub Actions 导入器在预测报告中包含过去七天。

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 工作流程。预演会在指定的目录中创建输出文件，但不会打开拉取请求来迁移管道。

要执行将 CircleCI 项目迁移到 GitHub Actions 的预演，请在您的终端中运行以下命令，将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 Importer”。

执行 CircleCI 管道的生产迁移

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

运行 migrate 命令

要将 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：用于使用转换后的工作流程创建拉取请求的个人访问令牌（经典版）（需要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 实例进行身份验证的个人访问令牌（经典版）（需要repo范围）。如果未提供，则使用GITHUB_ACCESS_TOKEN的值。
• CIRCLE_CI_SOURCE_GITHUB_INSTANCE_URL（可选）：源 GitHub 实例的 URL。如果未提供，则使用GITHUB_INSTANCE_URL的值。

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

可选参数

您可以将可选参数与 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参数向 GitHub Actions Importer 提供config.yml文件。例如，您可以在运行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 Actions	状态
cron 触发器	on.schedule	支持
环境	env jobs.<job_id>.env jobs.<job_id>.steps.env	支持
执行器	runs-on	支持
作业	作业	支持
作业	jobs.<job_id> jobs.<job_id>.name	支持
矩阵	jobs.<job_id>.strategy jobs.<job_id>.strategy.matrix	支持
参数	env workflow-dispatch.inputs	支持
步骤	jobs.<job_id>.steps	支持
when，unless	jobs.<job_id>.if	支持
触发器	on	支持
执行器	容器 服务	部分支持
orbs	操作	部分支持
执行器	自托管运行器	不支持
设置	不适用	不支持
版本	不适用	不支持

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

环境变量映射

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

CircleCI	GitHub Actions
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 }}

法律声明

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