简介
创建操作后,您需要继续发布新功能,同时处理社区贡献。 本教程介绍了一个示例过程,您可以遵循该过程在开源中发布和维护操作。 示例:
- 利用 GitHub Actions 实现持续集成、依赖项更新、版本管理和任务自动化。
- 通过自动化测试和构建徽章提供信心。
- 指示如何使用操作,理想情况下,作为更广泛的工作流程的一部分。
- 表明您欢迎哪种类型的社区贡献。 (例如,议题、拉取请求或漏洞报告。)
有关此过程的应用示例,请参阅 github-developer/javascript-action。
开发和发布操作
在本节中,我们将讨论开发和发布操作的示例流程,并演示如何使用 GitHub Actions 自动执行该过程。
关于 JavaScript 操作
JavaScript 操作是具有元数据的 Node.js 存储库。 但是,与传统的 Node.js 项目相比,JavaScript 操作具有其他属性:
- Dependent 包与代码一起提交,通常采用编译和缩小的形式。 这意味着自动化构建和安全的社区贡献非常重要。
- 许多操作都使用 GitHub 的 API 和第三方 API,因此我们鼓励进行强大的端到端测试。
设置 GitHub Actions 工作流程
要在下一节中支持开发人员流程,请将两个 GitHub Actions 工作流程添加到存储库中:
- 添加在将提交推送到功能分支或
main
分支或者创建拉取请求时触发的工作流程。 配置工作流程以运行单元和集成测试。 有关示例,请参阅此工作流程。 - 添加在发布或编辑发布时触发的工作流程。 配置工作流程以确保语义标记已就位。 您可以使用像 JasonEtco/build-and-tag-action 这样的操作来编译和捆绑 JavaScript 和元数据文件,并强制推送语义主要、次要和补丁标记。 有关示例,请参阅此工作流程。 有关语义标记的详细信息,请参阅“关于语义版本控制”。
示例开发者流程
下面是一个示例过程,您可以遵循该过程来自动运行测试、创建发行版,然后发布您的操作。
-
在每个 GitHub 流程的分支中执行功能工作。 更多信息请参阅“GitHub 流”。
- 每当将提交推送到功能分支时,测试工作流程将自动运行测试。
-
创建对
main
分支的拉取请求,以启动讨论和审阅,并在准备就绪时合并。-
当从分支或复刻打开拉取请求时,测试工作流将再次运行测试,这次是合并提交。
-
注意:出于安全原因,由复刻中的
pull_request
触发的工作流程限制了GITHUB_TOKEN
权限,并且无法访问机密。 如果在拉取请求时触发的测试或其他工作流程需要访问机密,请考虑使用其他事件,如 manual trigger 或pull_request_target
。 在此处阅读更多。
-
-
创建语义标记的版本。 更多信息请参阅“管理存储库中的版本”。
结果
与其他一些自动化版本管理策略不同,此过程有意不将依赖项提交到 main
分支,而只提交到标记的版本提交。 这样可以鼓励操作的用户引用命名标记或 sha
s,并且通过在发布期间自己执行构建来帮助确保第三方拉取请求的安全性。
使用语义发行版意味着操作的用户可以将其工作流程固定到某个版本,并且知道他们可能会继续接收最新的稳定、不间断功能,具体取决于他们的舒适度:
与社区合作
GitHub AE 提供工具和指南,帮助您与开源社区合作。 以下是我们建议为健康的双向通信设置的一些工具。 通过向社区提供以下信号,您可以鼓励其他人使用、修改和参与您的操作:
- 维护一个其中包含大量使用示例和指南的
README
。 更多信息请参阅“关于自述文件”。 - 在
README
文件中包括工作流程状态徽章。 更多信息请参阅“添加工作流程状态徽章”。 另请访问 shields.io,了解您可以添加的其他徽章。 - 利用 actions/stale等操作使议题保持最新。
延伸阅读
采用类似模式的示例包括: