示例概述
本文使用示例工作流演示 GitHub Actions 的某些主要 CI 功能。触发此工作流时,它将使用 npm test
的测试组合矩阵来测试代码。
下图显示了工作流步骤的高级视图以及它们如何在作业中运行:
此示例中使用的功能
示例工作流演示了 GitHub Actions 的以下功能。
功能 | 实现 |
---|---|
从 UI 手动运行工作流 | workflow_dispatch |
示例工作流
GitHub Docs 工程团队创建了以下工作流。 若要查看 github/docs
存储库中此文件的最新版本,请参阅 test.yml
。
注意:此工作流的每一行将在下一部分“了解示例”中介绍。
|
了解示例
下表介绍了在创建 GitHub Actions 工作流时如何使用这些功能。
代码 | 解释 |
---|---|
|
将显示在 GitHub 存储库的“操作”选项卡中的工作流名称。 |
|
通过 |
|
如果要在 UI 中手动运行此工作流,请添加 |
|
添加 |
|
添加 |
|
修改授予 |
|
为特定事件创建并发组,并使用 |
|
取消同一并发组中任何当前正在运行的作业或工作流。 |
|
将工作流文件中运行的所有作业组合在一起。 |
|
定义 ID 为 |
|
根据运行工作流的存储库,将作业配置为在 GitHub 托管的运行器或自托管运行器上运行。 在此示例中,如果存储库名为 |
|
设置作业在自动取消之前运行的最大分钟数。 有关详细信息,请参阅 |
|
本部分定义作业的生成矩阵。 |
|
将 |
|
创建名为 |
|
将作为 |
|
|
|
如果当前存储库是 |
|
如果当前存储库是 |
|
如果当前存储库是 |
|
此步骤运行一个命令,从存储库签出 LFS 对象。 |
|
此步骤使用 |
|
此步骤运行 shell 命令,该命令使用上一步的输出创建文件,其中包含在拉取请求中更改的文件列表。 |
|
此步骤使用 |
|
此步骤运行 |
|
此步骤运行生成脚本。 |
|
此步骤使用 |
后续步骤
- 若要了解 GitHub Actions 概念,请参阅“了解 GitHub Actions”。
- 有关创建基本工作流的分步指南,请参阅“GitHub Actions 快速入门”。
- 如果你熟悉 GitHub Actions 的基础知识,可以在“关于工作流程”中了解工作流及其功能。