You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Workflow templates can be created by users with write access to the organization's `.github`repository. The templates can then be used by organization members who have permission to create workflows.
29
29
30
30
{% ifversion fpt %}
31
31
Your workflow templates can be used to create workflows in public repositories only. Organizations using {% data variables.product.prodname_ghe_cloud %} can also use workflow templates to create workflows in private repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/learn-github-actions/creating-workflow-templates).
@@ -39,15 +39,15 @@ Your workflow templates can be used to create workflows in public repositories o
39
39
{% endnote %}
40
40
{% endif %}
41
41
42
-
此过程展示如何创建工作流程模板和元数据文件。 元数据文件描述在用户新建工作流程时如何向其显示模板。
42
+
This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the template is presented to users when they are creating a new workflow.
43
43
44
-
1.如果组织中没有名为 `.github`的公共仓库，请新建一个。
45
-
2.创建一个名为 `workflow-templates` 的目录。
46
-
3.在 `workflow-templates`目录中创建新的工作流程文件。
44
+
1.If it doesn't already exist, create a new public repository named `.github`in your organization.
45
+
2.Create a directory named `workflow-templates`.
46
+
3.Create your new workflow file inside the `workflow-templates`directory.
If you need to refer to a repository's default branch, you can use the `$default-branch`placeholder. When a workflow is created using your template, the placeholder will be automatically replaced with the name of the repository's default branch.
4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`:
72
72
```yaml
73
73
{
74
74
"name": "Octo Organization Workflow",
@@ -84,16 +84,16 @@ Your workflow templates can be used to create workflows in public repositories o
* `name` - **Required.** The name of the workflow template. This is displayed in the list of available templates.
88
+
* `description` - **Required.** The description of the workflow template. This is displayed in the list of available templates.
89
+
* `iconName` - **Optional.** Defines an icon for the workflow's entry in the template list. The `iconName` must be an SVG icon of the same name, and must be stored in the `workflow-templates` directory. For example, a SVG file named `example-icon.svg` is referenced as `example-icon`.
90
+
* `categories` - **Optional.** Defines the language category of the workflow. When a user views the available templates, those templates that match the same language will feature more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml.
91
+
* `filePatterns` - **Optional.** Allows the template to be used if the user's repository has a file in its root directory that matches a defined regular expression.
To continue learning about {% data variables.product.prodname_actions %}, see "[Using workflow templates](/actions/learn-github-actions/using-workflow-templates)."
0 commit comments