starter-workflows

<p align="center"> <img src="https://avatars0.githubusercontent.com/u/44036562?s=100&v=4"/> </p>

入门工作流程

这些是帮助人们开始使用 GitHub Actions 的工作流程文件。每当你开始创建新的 GitHub Actions 工作流程时，它们都会被展示。

如果你想开始使用 GitHub Actions，可以通过点击你想创建工作流程的仓库中的"Actions"标签来使用这些入门工作流程。

<img src="https://yellow-cdn.veclightyear.com/835a84d5/212f05c0-68e8-4136-8b97-614fba71db69.png" max-width="75%"/>

目录结构

• ci：持续集成工作流程的解决方案
• deployments：部署工作流程的解决方案
• automation：自动化工作流程的解决方案
• code-scanning：代码扫描的解决方案
• pages：Pages 工作流程的解决方案
• icons：相关模板的 svg 图标

每个工作流程必须使用 YAML 编写，并具有 .yml 扩展名。它们还需要一个相应的 .properties.json 文件，其中包含有关工作流程的额外元数据（这将显示在 GitHub.com 的用户界面中）。

例如：ci/django.yml 和 ci/properties/django.properties.json。

有效属性

• name：在引导过程中显示的名称。此属性在仓库中是唯一的。
• description：在引导过程中显示的描述
• iconName：相关文件夹中的图标名称，例如，django 应该有一个图标 icons/django.svg。目前仅支持 SVG 格式。另一个选项是使用 octicon。使用 octicon 的格式是 octicon <<图标名称>>。例如：octicon person
• creator：在引导过程中显示的模板创建者。同一作者的所有工作流程模板将具有相同的 creator 字段。
• categories：它将显示在哪些类别下。从此处的列表中至少选择一个类别。此外，从此处可用的语言列表和此处可用的技术栈列表中选择类别。当用户查看可用模板时，与语言和技术栈匹配的模板将更加突出。

类别

• 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": "使用 npm 构建和测试 Node.js 项目。",
    "iconName": "nodejs",
    "categories": ["Continuous integration", "JavaScript", "npm", "React", "Angular", "Vue"],
    "labels": ["preview"]
}

要查看带有 preview 标签的模板，请在"新建工作流程"页面 URL 中提供查询参数 preview=true。例如：https://github.com/<所有者>/<仓库名称>/actions/new?preview=true。

对公众启用模板

从 properties.json 文件中删除 labels 数组，以将模板发布给公众