actions/starter-workflows

GitHub: actions/starter-workflows

该仓库提供了由 GitHub 官方维护的 Actions 工作流模板集,旨在帮助开发者通过预设配置快速启动 CI/CD、自动化部署及代码安全扫描。

Stars: 11320 | Forks: 6839

## 入门工作流 这些是帮助人们开始使用 GitHub Actions 的工作流文件。每当你开始创建新的 GitHub Actions 工作流时,它们都会出现。 **如果你想开始使用 GitHub Actions,可以在想要创建工作流的仓库中点击 "Actions" 标签来使用这些入门工作流。** ### 注意 感谢你对这个 GitHub 仓库感兴趣,但是,目前我们不接受贡献。 我们继续将资源集中在能帮助客户成功并让开发者生活更轻松的战略领域。虽然 GitHub Actions 仍然是这一愿景的关键部分,但我们正在将资源分配到 Actions 的其他领域,目前不接受对此仓库的贡献。GitHub 公共路线图是了解我们要开发的功能及其所处阶段的最佳场所。 我们将采取以下步骤来更好地处理与 GitHub Actions 相关的请求,包括: 1. 我们将把问题和支持请求引导至我们的 [社区讨论区](https://github.com/orgs/community/discussions/categories/actions) 2. 高优先级错误可以通过社区讨论报告,或者你可以向我们的支持团队 https://support.github.com/contact/bug-report 报告。 3. 安全问题应按照我们的 [security.md](security.md) 处理 在此期间,我们仍将为此项目提供安全更新并修复重大变更。 你仍然可以在这个仓库中提交错误。 ### 目录结构 * [ci](ci):持续集成 工作流的解决方案 * [deployments](deployments):部署工作流的解决方案 * [automation](automation):自动化工作流的解决方案 * [code-scanning](code-scanning):[代码扫描](https://github.com/features/security) 的解决方案 * [pages](pages):Pages 工作流的解决方案 * [icons](icons):相关模板的 svg 图标 每个工作流必须用 YAML 编写并具有 `.yml` 扩展名。它们还需要一个相应的 `.properties.json` 文件,其中包含有关工作流的额外元数据(这将显示在 GitHub.com UI 中)。 例如:`ci/django.yml` 和 `ci/properties/django.properties.json`。 ### 有效属性 * `name`:引导过程中显示的名称。此属性在仓库中是唯一的。 * `description`:引导过程中显示的描述 * `iconName`:相关文件夹中的图标名称,例如,`django` 应该有一个图标 `icons/django.svg`。目前仅支持 SVG。另一种选择是使用 [octicon](https://primer.style/octicons/)。使用 octicon 的格式是 `octicon <>`。例如:`octicon person` * `creator`:引导过程中显示的模板创建者。来自同一作者的所有工作流模板将具有相同的 `creator` 字段。 * `categories`:模板将显示在哪些类别下。至少从[此处](#categories)的列表中选择一个类别。此外,请从[此处](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)可用的语言列表和[此处](https://github.com/github-starter-workflows/repo-analysis-partner/blob/main/tech_stacks.yml)可用的技术栈列表中选择类别。当用户查看可用模板时,那些匹配语言和技术栈的模板将更加突出地显示。 ### 类别 * continuous-integration * deployment * testing * code-quality * code-review * dependency-management * monitoring * Automation * utilities * Pages * Hugo ### 变量 这些变量可以放在入门工作流中,并将按如下详细说明进行替换: * `$default-branch`:将替换为仓库的分支,例如 `main` 和 `master` * `$protected-branches`:将替换为仓库中的任何受保护分支 * `$cron-daily`:将替换为当天内一个有效但随机的时间 ## 发布前如何测试模板 ### 对公众禁用模板 模板作者在模板的 `properties.json` 文件中添加一个包含 `preview` 标签的 `labels` 数组。这将对用户隐藏模板,除非用户在 URL 中使用查询参数 `preview=true`。 示例 `properties.json` 文件: ``` { "name": "Node.js", "description": "Build and test a Node.js project with npm.", "iconName": "nodejs", "categories": ["Continuous integration", "JavaScript", "npm", "React", "Angular", "Vue"], "labels": ["preview"] } ``` 要查看带有 `preview` 标签的模板,请在 `new workflow` 页面 URL 中提供查询参数 `preview=true`。例如:`https://github.com///actions/new?preview=true`。 ### 对公众启用模板 从 `properties.json` 文件中移除 `labels` 数组以将模板发布给公众
标签:GitHub Actions, Starter Workflows, 初学者, 工作流, 开源, 开源框架, 持续部署, 持续集成, 构建, 模板, 测试, 网络调试, 脚手架, 自动化, 自动化攻击, 自动化攻击, 自动化运维, 自动笔记, 软件开发, 部署