From 25722e982a30a16f7e4d4abe8ef8df254d0df70a Mon Sep 17 00:00:00 2001 From: Rob Bos Date: Thu, 12 Jan 2023 03:45:32 +0100 Subject: [PATCH] Update options for Actions starter workflows (#23048) Co-authored-by: Lucas Costi --- ...creating-starter-workflows-for-your-organization.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md b/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md index ad1fc32d99..3009f643fe 100644 --- a/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md +++ b/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md @@ -89,8 +89,14 @@ This procedure demonstrates how to create a starter workflow and metadata file. ``` * `name` - **Required.** The name of the workflow. This is displayed in the list of available workflows. * `description` - **Required.** The description of the workflow. This is displayed in the list of available workflows. - * `iconName` - **Optional.** Specifies an icon for the workflow that's displayed in the list of workflows. The `iconName` must be the name of an SVG file, without the file name extension, stored in the `workflow-templates` directory. For example, an SVG file named `example-icon.svg` is referenced as `example-icon`. - * `categories` - **Optional.** Defines the language category of the workflow. When a user views the available starter workflows for a repository, the workflows that match the identified language for the project are featured more prominently. For information on the available language categories, see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml. + * `iconName` - **Optional.** Specifies an icon for the workflow that is displayed in the list of workflows. `iconName` can one of the following types: + * An SVG file that is stored in the `workflow-templates` directory. To reference a file, the value must be the file name without the file extension. For example, an SVG file named `example-icon.svg` is referenced as `example-icon`. + * An icon from {% data variables.product.prodname_dotcom %}'s set of [Octicons](https://primer.style/octicons/). To reference an octicon, the value must be `octicon `. For example, `octicon smiley`. + * `categories` - **Optional.** Defines the categories that the workflow is shown under. You can use category names from the following lists: + * General category names from the [starter-workflows](https://github.com/actions/starter-workflows/blob/main/README.md#categories) repository. + * Linguist languages from the list in the [linguist](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) repository. + * Supported tech stacks from the list in the [starter-workflows](https://github.com/github-starter-workflows/repo-analysis-partner/blob/main/tech_stacks.yml) repository. + * `filePatterns` - **Optional.** Allows the workflow to be used if the user's repository has a file in its root directory that matches a defined regular expression. To add another starter workflow, add your files to the same `workflow-templates` directory. For example: