如何将自定义GitHub Workflow发布为启动工作流或提供导入链接?
实现GitHub工作流的直接导入方案
一、生成直接跳转的导入链接(最快实现)
你可以直接构造一个GitHub导入链接,用户点击后就能将你的工作流一键导入到新仓库,无需复制粘贴:
- 确保你的工作流文件(比如
sphinx-docs.yml)放在仓库的.github/workflows/目录下 - 按照以下格式拼接链接:
比如你的仓库是https://github.com/new?template_name=<你的工作流文件名>&template_owner=<你的GitHub用户名>&template_path=.github/workflowsahmad88me/sphinx_example_includer,工作流文件是sphinx-build.yml,链接就是:https://github.com/new?template_name=sphinx-build.yml&template_owner=ahmad88me&template_path=.github/workflows - 用户点击这个链接,会进入GitHub的新建仓库页面,你的工作流会自动被导入到新仓库的
.github/workflows/目录中
二、申请成为GitHub官方启动工作流(门槛较高)
GitHub官方启动工作流是由GitHub维护的通用模板,要加入需要:
- 提交PR到GitHub官方的
actions/starter-workflows仓库 - 你的工作流必须满足通用场景需求、符合GitHub Actions最佳实践、有完善的文档和测试案例
- 官方会严格审核,只有覆盖广泛通用需求的工作流才会被收录,除非你的Sphinx工作流是极具通用性的标准方案,否则成功率较低
三、替代方案:将仓库设为模板仓库
把你的sphinx_example_includer仓库设置为GitHub模板仓库:
- 进入仓库的「Settings」页面
- 在「Template repository」选项下勾选「Template repository」
- 用户可以点击仓库页面的「Use this template」按钮,直接创建包含你的工作流的新仓库,同样无需复制粘贴
内容的提问来源于stack exchange,提问作者ahmad88me
相关产品推荐
相关产品推荐

