diff options
Diffstat (limited to 'doc/development/cicd')
| -rw-r--r-- | doc/development/cicd/index.md | 2 | ||||
| -rw-r--r-- | doc/development/cicd/pipeline_wizard.md | 15 | ||||
| -rw-r--r-- | doc/development/cicd/templates.md | 5 |
3 files changed, 13 insertions, 9 deletions
diff --git a/doc/development/cicd/index.md b/doc/development/cicd/index.md index e8e116037de..7a2dfa01d1e 100644 --- a/doc/development/cicd/index.md +++ b/doc/development/cicd/index.md @@ -37,7 +37,7 @@ On the left side we have the events that can trigger a pipeline based on various - When a [merge request is created or updated](../../ci/pipelines/merge_request_pipelines.md). - When an MR is added to a [Merge Train](../../ci/pipelines/merge_trains.md#merge-trains). - A [scheduled pipeline](../../ci/pipelines/schedules.md). -- When project is [subscribed to an upstream project](../../ci/pipelines/multi_project_pipelines.md#trigger-a-pipeline-when-an-upstream-project-is-rebuilt). +- When project is [subscribed to an upstream project](../../ci/pipelines/index.md#trigger-a-pipeline-when-an-upstream-project-is-rebuilt). - When [Auto DevOps](../../topics/autodevops/index.md) is enabled. - When GitHub integration is used with [external pull requests](../../ci/ci_cd_for_external_repos/index.md#pipelines-for-external-pull-requests). - When an upstream pipeline contains a [bridge job](../../ci/yaml/index.md#trigger) which triggers a downstream pipeline. diff --git a/doc/development/cicd/pipeline_wizard.md b/doc/development/cicd/pipeline_wizard.md index 7a0b70bd8e8..227a49d85db 100644 --- a/doc/development/cicd/pipeline_wizard.md +++ b/doc/development/cicd/pipeline_wizard.md @@ -58,7 +58,7 @@ consists of 2-3 steps, for a total of 3-4 steps visible to the user. ```yaml # ~/pipeline_wizard/templates/my_template.yml - +id: gitlab/my-template title: Set up my specific tech pipeline description: Here's two or three introductory sentences that help the user understand what this wizard is going to set up. steps: @@ -156,12 +156,13 @@ Webpack does not parse it as an Object. In the root element of the template file, you can define the following properties: -| Name | Required | Type | Description | -|---------------|------------------------|--------|---------------------------------------------------------------------------------------| -| `title` | **{check-circle}** Yes | string | The page title as displayed to the user. It becomes an `h1` heading above the wizard. | -| `description` | **{check-circle}** Yes | string | The page description as displayed to the user. | -| `filename` | **{dotted-circle}** No | string | The name of the file that is being generated. Defaults to `.gitlab-ci.yml`. | -| `steps` | **{check-circle}** Yes | list | A list of [step definitions](#step-reference). | +| Name | Required | Type | Description | +|---------------|------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | **{check-circle}** Yes | string | A unique template ID. This ID should follow a namespacing pattern, with a forward slash `/` as separator. Templates committed to GitLab source code should always begin with `gitlab`. For example: `gitlab/my-template` | +| `title` | **{check-circle}** Yes | string | The page title as displayed to the user. It becomes an `h1` heading above the wizard. | +| `description` | **{check-circle}** Yes | string | The page description as displayed to the user. | +| `filename` | **{dotted-circle}** No | string | The name of the file that is being generated. Defaults to `.gitlab-ci.yml`. | +| `steps` | **{check-circle}** Yes | list | A list of [step definitions](#step-reference). | ### `step` Reference diff --git a/doc/development/cicd/templates.md b/doc/development/cicd/templates.md index 4ea7a9d960c..d0c56fb18bc 100644 --- a/doc/development/cicd/templates.md +++ b/doc/development/cicd/templates.md @@ -465,7 +465,10 @@ To add a metric definition for a new template: - `name:` and `performance_indicator_type:`: Delete (not needed). - `introduced_by_url:`: The URL of the MR adding the template. - `data_source:`: Set to `redis_hll`. - - All other fields that have no values: Set to empty strings (`''`). + - `description`: Add a short description of what this metric counts, for example: `Count of pipelines using the latest Auto Deploy template` + - `product_*`: Set to [section, stage, group, and feature category](https://about.gitlab.com/handbook/product/categories/#devops-stages) + as per the [metrics dictionary guide](../service_ping/metrics_dictionary.md#metrics-definition-and-validation). + If you are unsure what to use for these keywords, you can ask for help in the merge request. - Add the following to the end of each file: ```yaml |