使用 GitHub Actions Importer 从 Azure DevOps 迁移

法律声明

关于使用 GitHub Actions Importer 从 Azure DevOps 迁移

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

先决条件

• 一个 Azure DevOps 帐户或组织，其中包含要转换为 GitHub Actions 工作流的项目和管道。

• 访问权限，可为你的帐户或组织创建 Azure DevOps 个人访问令牌。

• 一个可运行基于 Linux 的容器的环境，并且可以安装必要的工具。

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

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

限制

使用 GitHub Actions Importer 从 Azure DevOps 迁移到 GitHub Actions 时存在一些限制

• GitHub Actions Importer 要求 Azure DevOps API 的 5.0 版本，该版本在 Azure DevOps Services 或 Azure DevOps Server 2019 中可用。较旧版本的 Azure DevOps Server 不兼容。
• 隐式添加到 Azure DevOps 管道的任务（例如签出源代码）可能会以 GUID 名称添加到 GitHub Actions Importer 审核中。若要查找 GUID 的友好任务名称，可以使用以下 URL：https://dev.azure.com/:organization/_apis/distributedtask/tasks/:guid。

手动任务

某些 Azure DevOps 构造必须从 Azure DevOps 手动迁移到 GitHub Actions 配置中。这些包括

• 组织、存储库和环境机密
• 服务连接，例如 OIDC Connect、GitHub 应用和个人访问令牌
• 未知任务
• 自托管代理
• 环境
• 部署前审批

有关手动迁移的更多信息，请参阅“从 Azure Pipelines 迁移到 GitHub Actions”。

不受支持的任务

GitHub Actions Importer 不支持迁移以下任务

• 部署前闸门
• 部署后闸门
• 部署后审批
• 一些资源触发器

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

1. 创建 GitHub 个人访问令牌（经典）。有关详细信息，请参阅“管理个人访问令牌”。

   令牌必须具有 workflow 范围。

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

2. 创建 Azure DevOps 个人访问令牌。有关详细信息，请参阅 Azure DevOps 文档中的 使用个人访问令牌。令牌必须具有以下范围

   • 代理池：读取
   • 生成：读取
   • 代码：读取
   • 发布：读取
   • 服务连接：读取
   • 任务组：读取
   • 变量组：读取

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

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

   gh actions-importer configure
   

   configure 命令将提示你提供以下信息

   • 对于“要配置哪些 CI 提供商？”，使用箭头键选择 Azure DevOps，按 空格键 选择它，然后按 Enter。
   • 对于“GitHub 的个人访问令牌”，输入之前创建的个人访问令牌（经典）的值，然后按 Enter。
   • 对于“GitHub 实例的基本 URL”，按 Enter 接受默认值 (https://github.com)。
   • 对于“Azure DevOps 的个人访问令牌”，输入之前创建的 Azure DevOps 个人访问令牌的值，然后按 Enter。
   • 对于“Azure DevOps 实例的基本 URL”，按 Enter 接受默认值 (https://dev.azure.com)。
   • 对于“Azure DevOps 组织名称”，输入 Azure DevOps 组织的名称，然后按 Enter。
   • 对于“Azure DevOps 项目名称”，输入 Azure DevOps 项目的名称，然后按 Enter。

   下面显示了 configure 命令的一个示例

   $ gh actions-importer configure
   ✔ Which CI providers are you configuring?: Azure DevOps
   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 Azure DevOps: ***************
   ✔ Base url of the Azure DevOps instance: https://dev.azure.com
   ✔ Azure DevOps organization name: :organization
   ✔ Azure DevOps project name: :project
   Environment variables successfully updated.
   

4. 在终端中，运行 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
   

执行 Azure DevOps 审核

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

audit 命令执行以下步骤

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

运行 audit 命令

要执行 Azure DevOps 组织的审核，请在终端中运行以下命令

gh actions-importer audit azure-devops --output-dir tmp/audit

检查审核结果

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

审核摘要包含以下部分。

管道

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

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

• 成功管道已将 100% 的管道构造和各个项目自动转换为其 GitHub Actions 等效项。
• 部分成功管道已转换所有管道构造，但是有一些各个项目未自动转换为其 GitHub Actions 等效项。
• 不受支持的管道是 GitHub Actions Importer 不支持的定义类型。
• 失败管道在转换时遇到致命错误。这可能是由于以下三个原因之一
  • 管道配置错误，在 Bamboo 中无效。
  • 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 命令通过计算 Azure DevOps 中已完成的管道运行中的指标来预测潜在的 GitHub Actions 使用情况。

运行预测命令

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

gh actions-importer forecast azure-devops --output-dir tmp/forecast_reports

检查预测报告

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

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

• 作业数是已完成作业的总数。

• 管道数是使用的唯一管道的数量。

• 执行时间描述了运行程序在作业上花费的时间。此指标可用于帮助规划 GitHub 托管的运行程序的成本。

  此指标与您在 GitHub Actions 中预计要花费的金额相关。这会根据用于这些分钟的硬件而有所不同。您可以使用 GitHub Actions 定价计算器 来估算成本。

• 队列时间指标描述了作业等待运行程序可用以执行它所花费的时间。

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

此外，这些指标针对 Azure DevOps 中的每个运行程序队列进行定义。如果混合使用了托管或自托管运行程序，或者使用高规格或低规格计算机，这将特别有用，这样您就可以看到特定于不同类型运行程序的指标。

执行试运行迁移

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

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

为构建管道运行试运行命令

若要对将 Azure DevOps 构建管道迁移到 GitHub Actions 进行试运行，请在终端中运行以下命令，用您要转换的管道的 ID 替换 pipeline_id。

gh actions-importer dry-run azure-devops pipeline --pipeline-id :pipeline_id --output-dir tmp/dry-run

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

为发布管道运行试运行命令

若要对将 Azure DevOps 发布管道迁移到 GitHub Actions 进行试运行，请在终端中运行以下命令，用您要转换的管道的 ID 替换 pipeline_id。

gh actions-importer dry-run azure-devops release --pipeline-id :pipeline_id --output-dir tmp/dry-run

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

执行生产迁移

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

为构建管道运行迁移命令

若要将 Azure DevOps 构建管道迁移到 GitHub Actions，请在终端中运行以下命令，将 target-url 值替换为 GitHub 存储库的 URL，将 pipeline_id 替换为要转换的管道的 ID。

gh actions-importer migrate azure-devops pipeline --pipeline-id :pipeline_id --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate

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

$ gh actions-importer migrate azure-devops pipeline --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --azure-devops-project my-azure-devops-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'

为发布管道运行迁移命令

若要将 Azure DevOps 发布管道迁移到 GitHub Actions，请在终端中运行以下命令，将 target-url 值替换为 GitHub 存储库的 URL，将 pipeline_id 替换为要转换的管道的 ID。

gh actions-importer migrate azure-devops release --pipeline-id :pipeline_id --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate

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

$ gh actions-importer migrate azure-devops release --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --azure-devops-project my-azure-devops-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 从 Azure DevOps 迁移时支持的语法的参考信息。

配置环境变量

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

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

• GITHUB_ACCESS_TOKEN：用于创建包含转换后工作流的拉取请求的个人访问令牌（经典版）（需要 workflow 范围）。
• GITHUB_INSTANCE_URL：指向目标 GitHub 实例的 URL（例如，https://github.com）。
• AZURE_DEVOPS_ACCESS_TOKEN：用于使用 Azure DevOps 实例进行身份验证的个人访问令牌。此令牌需要以下范围
  • 生成：读取
  • 代理池：读取
  • 代码：读取
  • 发布：读取
  • 服务连接：读取
  • 任务组：读取
  • 变量组：读取
• AZURE_DEVOPS_PROJECT：迁移管道时要使用的项目名称或 GUID。如果您想对所有项目执行审核，则此项是可选的。
• AZURE_DEVOPS_ORGANIZATION：Azure DevOps 实例的组织名称。
• AZURE_DEVOPS_INSTANCE_URL：Azure DevOps 实例的 URL，例如 https://dev.azure.com。

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

可选参数

您可以将可选参数与 GitHub Actions Importer 子命令一起使用，以自定义您的迁移。

--source-file-path

您可以在 forecast、dry-run 或 migrate 子命令中使用 --source-file-path 参数。

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

例如

gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --source-file-path ./path/to/azure_devops/pipeline.yml

--config-file-path

您可以在 audit、dry-run 和 migrate 子命令中使用 --config-file-path 参数。

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

--config-file-path 参数还可用于指定应将转换后的可重用工作流或复合操作迁移到的存储库。

审核示例

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

gh actions-importer audit azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml

要使用配置文件审核 Azure DevOps 实例，配置文件必须采用以下格式，并且每个 repository_slug 必须唯一

source_files:
  - repository_slug: azdo-project/1
    path: file.yml
  - repository_slug: azdo-project/2
    paths: path.yml

您可以通过组合 Azure DevOps 组织名称、项目名称和管道 ID 来生成管道的 repository_slug。例如，my-organization-name/my-project-name/42。

干运行示例

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

通过将配置文件中的 repository_slug 与 --azure-devops-organization 和 --azure-devops-project 选项的值进行匹配来选择管道。然后使用 path 来提取指定的源文件。

gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml

指定转换后的可重用工作流和复合操作的存储库

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

首先，您应该运行一次不带 --config-file-path 参数的审计

gh actions-importer audit azure-devops --output-dir ./output/

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

reusable_workflows:
  - name: my-reusable-workflow.yml
    target_url: https://github.com/octo-org/octo-repo
    ref: main

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 azure-devops pipeline  --config-file-path config.yml --target-url https://github.com/my-org/my-repo

Azure DevOps 管道的受支持语法

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

Azure Pipelines	GitHub Actions	状态
条件	jobs.<job_id>.if jobs.<job_id>.steps[*].if	受支持
容器	jobs.<job_id>.container jobs.<job_id>.name	受支持
continuousIntegration	on.<push>.<branches> on.<push>.<tags> on.<push>.paths	受支持
作业	jobs.<job_id>	受支持
pullRequest	on.<pull_request>.<branches> on.<pull_request>.paths	受支持
阶段	作业	受支持
步骤	jobs.<job_id>.steps	受支持
策略	jobs.<job_id>.strategy.fail-fast jobs.<job_id>.strategy.max-parallel jobs.<job_id>.strategy.matrix	受支持
timeoutInMinutes	jobs.<job_id>.timeout-minutes	受支持
变量	env jobs.<job_id>.env jobs.<job_id>.steps.env	受支持
手动部署	jobs.<job_id>.environment	部分支持
池	运行程序 自托管运行程序	部分支持
服务	jobs.<job_id>.services	部分支持
策略	jobs.<job_id>.strategy	部分支持
触发器	on	部分支持
pullRequest	on.<pull_request>.<tags>	不受支持
计划	on.schedule on.workflow_run	不受支持
触发器	on.<event_name>.types	不受支持

有关受支持的 Azure DevOps 任务的更多信息，请参阅 github/gh-actions-importer 存储库。

环境变量映射

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

Azure Pipelines	GitHub Actions
$(Agent.BuildDirectory)	${{ runner.workspace }}
$(Agent.HomeDirectory)	${{ env.HOME }}
$(Agent.JobName)	${{ github.job }}
$(Agent.OS)	${{ runner.os }}
$(Agent.ReleaseDirectory)	${{ github.workspace}}
$(Agent.RootDirectory)	${{ github.workspace }}
$(Agent.ToolsDirectory)	${{ runner.tool_cache }}
$(Agent.WorkFolder)	${{ github.workspace }}
$(Build.ArtifactStagingDirectory)	${{ runner.temp }}
$(Build.BinariesDirectory)	${{ github.workspace }}
$(Build.BuildId)	${{ github.run_id }}
$(Build.BuildNumber)	${{ github.run_number }}
$(Build.DefinitionId)	${{ github.workflow }}
$(Build.DefinitionName)	${{ github.workflow }}
$(Build.PullRequest.TargetBranch)	${{ github.base_ref }}
$(Build.PullRequest.TargetBranch.Name)	${{ github.base_ref }}
$(Build.QueuedBy)	${{ github.actor }}
$(Build.Reason)	${{ github.event_name }}
$(Build.Repository.LocalPath)	${{ github.workspace }}
$(Build.Repository.Name)	${{ github.repository }}
$(Build.Repository.Provider)	GitHub
$(Build.Repository.Uri)	${{ github.server.url }}/${{ github.repository }}
$(Build.RequestedFor)	${{ github.actor }}
$(Build.SourceBranch)	${{ github.ref }}
$(Build.SourceBranchName)	${{ github.ref }}
$(Build.SourceVersion)	${{ github.sha }}
$(Build.SourcesDirectory)	${{ github.workspace }}
$(Build.StagingDirectory)	${{ runner.temp }}
$(Pipeline.Workspace)	${{ runner.workspace }}
$(Release.DefinitionEnvironmentId)	${{ github.job }}
$(Release.DefinitionId)	${{ github.workflow }}
$(Release.DefinitionName)	${{ github.workflow }}
$(Release.Deployment.RequestedFor)	${{ github.actor }}
$(Release.DeploymentID)	${{ github.run_id }}
$(Release.EnvironmentId)	${{ github.job }}
$(Release.EnvironmentName)	${{ github.job }}
$(Release.Reason)	${{ github.event_name }}
$(Release.RequestedFor)	${{ github.actor }}
$(System.ArtifactsDirectory)	${{ github.workspace }}
$(System.DefaultWorkingDirectory)	${{ github.workspace }}
$(System.HostType)	build
$(System.JobId)	${{ github.job }}
$(System.JobName)	${{ github.job }}
$(System.PullRequest.PullRequestId)	${{ github.event.number }}
$(System.PullRequest.PullRequestNumber)	${{ github.event.number }}
$(System.PullRequest.SourceBranch)	${{ github.ref }}
$(System.PullRequest.SourceRepositoryUri)	${{ github.server.url }}/${{ github.repository }}
$(System.PullRequest.TargetBranch)	${{ github.event.base.ref }}
$(System.PullRequest.TargetBranchName)	${{ github.event.base.ref }}
$(System.StageAttempt)	${{ github.run_number }}
$(System.TeamFoundationCollectionUri)	${{ github.server.url }}/${{ github.repository }}
$(System.WorkFolder)	${{ github.workspace }}

模板

你可以使用 GitHub Actions Importer 转换 Azure DevOps 模板。

限制

GitHub Actions Importer 可以转换 Azure DevOps 模板，但有一些限制。

• 在 stages、deployments 和 jobs 键下使用的 Azure DevOps 模板在 GitHub Actions 中转换为可重用工作流。有关详细信息，请参阅“重用工作流”。
• 在 steps 键下使用的 Azure DevOps 模板转换为复合操作。有关详细信息，请参阅“创建复合操作”。
• 如果你当前有引用其他作业模板的作业模板，GitHub Actions Importer 会将模板转换为可重用工作流。由于可重用工作流无法引用其他可重用工作流，因此这是 GitHub Actions 中的无效语法。你必须手动更正嵌套的可重用工作流。
• 如果模板引用外部 Azure DevOps 组织或 GitHub 存储库，你必须使用 --credentials-file 选项提供凭据来访问此模板。有关详细信息，请参阅“补充参数和设置”。
• 你可以使用 each 表达式动态生成 YAML，但需要注意以下事项
  • 不支持嵌套each块，并且会导致不支持父each块。
  • each和包含的if条件在转换时进行评估，因为 GitHub Actions 不支持这种插入方式。
  • 不支持elseif块。如果需要此功能，则必须手动更正它们。
  • 支持嵌套if块，但if/elseif/else块嵌套在if条件下则不支持。
  • 不支持使用预定义 Azure DevOps 变量的if块。

支持的模板

GitHub Actions Importer 支持下表中列出的模板。

Azure Pipelines	GitHub Actions	状态
从模板扩展	可重用工作流	受支持
作业模板	可重用工作流	受支持
阶段模板	可重用工作流	受支持
步骤模板	复合操作	受支持
经典编辑器中的任务组	各不相同	受支持
其他 Azure DevOps 组织、项目或存储库中的模板	各不相同	受支持
GitHub 存储库中的模板	各不相同	受支持
变量模板	env	受支持
条件插入	作业/步骤上的if条件	部分支持
迭代插入	不适用	部分支持
带参数的模板	各不相同	部分支持

模板文件路径名称

GitHub Actions Importer 可以提取具有相对或动态文件路径的模板，其中文件名称中包含变量、参数和迭代表达式。但是，必须设置默认值。

变量文件路径名称示例

# File: azure-pipelines.yml
variables:
- template: 'templates/vars.yml'

steps:
- template: "./templates/$"

# File: templates/vars.yml
variables:
  one: 'simple_step.yml'

参数文件路径名称示例

parameters:
- name: template
  type: string
  default: simple_step.yml

steps:
- template: "./templates/${{ parameters.template }}"

迭代文件路径名称示例

parameters:
- name: steps
  type: object
  default:
  - build_step
  - release_step
steps:
- ${{ each step in parameters.steps }}:
    - template: "$-variables.yml"

模板参数

GitHub Actions Importer 支持下表中列出的参数。

Azure Pipelines	GitHub Actions	状态
string	inputs.string	受支持
number	inputs.number	受支持
boolean	inputs.boolean	受支持
object	inputs.string with fromJSON expression	部分支持
step	step	部分支持
stepList	step	部分支持
作业	作业	部分支持
jobList	作业	部分支持
deployment	作业	部分支持
deploymentList	作业	部分支持
阶段	作业	部分支持
stageList	作业	部分支持

法律声明

部分内容根据 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.