Commit 03699455 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'docs-yaml-reference-lists' into 'master'

Make sure all possible inputs have a list

See merge request gitlab-org/gitlab!75603
parents dd19ceb0 93b3f81f
...@@ -199,8 +199,10 @@ use `include:file`. You can use `include:file` in combination with `include:proj ...@@ -199,8 +199,10 @@ use `include:file`. You can use `include:file` in combination with `include:proj
**Keyword type**: Global keyword. **Keyword type**: Global keyword.
**Possible inputs**: A full path, relative to the root directory (`/`). **Possible inputs**:
The YAML file must have the extension `.yml` or `.yaml`.
- A full path, relative to the root directory (`/`). The YAML file must have the
extension `.yml` or `.yaml`.
**Example of `include:file`**: **Example of `include:file`**:
...@@ -255,10 +257,10 @@ Use `include:remote` with a full URL to include a file from a different location ...@@ -255,10 +257,10 @@ Use `include:remote` with a full URL to include a file from a different location
**Keyword type**: Global keyword. **Keyword type**: Global keyword.
**Possible inputs**: A public URL accessible by an HTTP/HTTPS `GET` request. **Possible inputs**:
Authentication with the remote URL is not supported.
The YAML file must have the extension `.yml` or `.yaml`. - A public URL accessible by an HTTP/HTTPS `GET` request. Authentication with the
remote URL is not supported. The YAML file must have the extension `.yml` or `.yaml`.
**Example of `include:remote`**: **Example of `include:remote`**:
...@@ -281,7 +283,9 @@ Use `include:template` to include [`.gitlab-ci.yml` templates](https://gitlab.co ...@@ -281,7 +283,9 @@ Use `include:template` to include [`.gitlab-ci.yml` templates](https://gitlab.co
**Keyword type**: Global keyword. **Keyword type**: Global keyword.
**Possible inputs**: [`.gitlab-ci.yml` templates](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates). **Possible inputs**:
- [`.gitlab-ci.yml` templates](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates).
**Example of `include:template`**: **Example of `include:template`**:
...@@ -556,7 +560,9 @@ The default value for `allow_failure` is: ...@@ -556,7 +560,9 @@ The default value for `allow_failure` is:
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: `true` or `false`. **Possible inputs**:
- `true` or `false`.
**Example of `allow_failure`**: **Example of `allow_failure`**:
...@@ -894,7 +900,9 @@ included templates in jobs. ...@@ -894,7 +900,9 @@ included templates in jobs.
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: See list of available [artifacts reports types](artifacts_reports.md). **Possible inputs**:
- See list of available [artifacts reports types](artifacts_reports.md).
**Example of `artifacts:reports`**: **Example of `artifacts:reports`**:
...@@ -1024,14 +1032,15 @@ Use the `cache:paths` keyword to choose which files or directories to cache. ...@@ -1024,14 +1032,15 @@ Use the `cache:paths` keyword to choose which files or directories to cache.
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: An array of paths relative to the project directory (`$CI_PROJECT_DIR`). **Possible inputs**:
You can use wildcards that use [glob](https://en.wikipedia.org/wiki/Glob_(programming))
patterns:
- In [GitLab Runner 13.0 and later](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2620), - An array of paths relative to the project directory (`$CI_PROJECT_DIR`).
[`doublestar.Glob`](https://pkg.go.dev/github.com/bmatcuk/doublestar@v1.2.2?tab=doc#Match). You can use wildcards that use [glob](https://en.wikipedia.org/wiki/Glob_(programming))
- In GitLab Runner 12.10 and earlier, patterns:
[`filepath.Match`](https://pkg.go.dev/path/filepath#Match). - In [GitLab Runner 13.0 and later](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2620),
[`doublestar.Glob`](https://pkg.go.dev/github.com/bmatcuk/doublestar@v1.2.2?tab=doc#Match).
- In GitLab Runner 12.10 and earlier,
[`filepath.Match`](https://pkg.go.dev/path/filepath#Match).
**Example of `cache:paths`**: **Example of `cache:paths`**:
...@@ -1114,7 +1123,9 @@ which speeds up subsequent pipeline runs. ...@@ -1114,7 +1123,9 @@ which speeds up subsequent pipeline runs.
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: An array of one or two file paths. **Possible inputs**:
- An array of one or two file paths.
**Example of `cache:key:files`**: **Example of `cache:key:files`**:
...@@ -1190,7 +1201,9 @@ Use `untracked: true` to cache all files that are untracked in your Git reposito ...@@ -1190,7 +1201,9 @@ Use `untracked: true` to cache all files that are untracked in your Git reposito
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: `true` or `false` (default). **Possible inputs**:
- `true` or `false` (default).
**Example of `cache:untracked`**: **Example of `cache:untracked`**:
...@@ -1303,7 +1316,9 @@ line in the job output matches the regular expression. ...@@ -1303,7 +1316,9 @@ line in the job output matches the regular expression.
To extract the code coverage value in the matching line, GitLab uses this To extract the code coverage value in the matching line, GitLab uses this
regular expression: `\d+(\.\d+)?`. regular expression: `\d+(\.\d+)?`.
**Possible inputs**: A regular expression. Must start and end with `/`. **Possible inputs**:
- A regular expression. Must start and end with `/`.
**Example of `coverage`**: **Example of `coverage`**:
...@@ -1811,7 +1826,9 @@ where each shell token is a separate string in the array. ...@@ -1811,7 +1826,9 @@ where each shell token is a separate string in the array.
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: A string. **Possible inputs**:
- A string.
**Example of `image:entrypoint`**: **Example of `image:entrypoint`**:
...@@ -1918,7 +1935,9 @@ You can't cancel subsequent jobs after a job with `interruptible: false` starts. ...@@ -1918,7 +1935,9 @@ You can't cancel subsequent jobs after a job with `interruptible: false` starts.
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: `true` or `false` (default). **Possible inputs**:
- `true` or `false` (default).
**Example of `interruptible`**: **Example of `interruptible`**:
...@@ -2411,7 +2430,9 @@ to a pipeline, based on the status of [CI/CD variables](../variables/index.md). ...@@ -2411,7 +2430,9 @@ to a pipeline, based on the status of [CI/CD variables](../variables/index.md).
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: An array of [CI/CD variable expressions](../jobs/job_control.md#cicd-variable-expressions). **Possible inputs**:
- An array of [CI/CD variable expressions](../jobs/job_control.md#cicd-variable-expressions).
**Example of `only:variables`**: **Example of `only:variables`**:
...@@ -2490,7 +2511,9 @@ when the Kubernetes service is active in the project. ...@@ -2490,7 +2511,9 @@ when the Kubernetes service is active in the project.
**Keyword type**: Job-specific. You can use it only as part of a job. **Keyword type**: Job-specific. You can use it only as part of a job.
**Possible inputs**: The `kubernetes` strategy accepts only the `active` keyword. **Possible inputs**:
- The `kubernetes` strategy accepts only the `active` keyword.
**Example of `only:kubernetes`**: **Example of `only:kubernetes`**:
...@@ -2546,7 +2569,9 @@ Parallel jobs are named sequentially from `job_name 1/N` to `job_name N/N`. ...@@ -2546,7 +2569,9 @@ Parallel jobs are named sequentially from `job_name 1/N` to `job_name N/N`.
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: A numeric value from `2` to `50`. **Possible inputs**:
- A numeric value from `2` to `50`.
**Example of `parallel`**: **Example of `parallel`**:
...@@ -2579,7 +2604,9 @@ Multiple runners must exist, or a single runner must be configured to run multip ...@@ -2579,7 +2604,9 @@ Multiple runners must exist, or a single runner must be configured to run multip
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: A numeric value from `2` to `50`. **Possible inputs**:
- A numeric value from `2` to `50`.
**Example of `parallel:matrix`**: **Example of `parallel:matrix`**:
...@@ -2699,7 +2726,9 @@ New tags use the SHA associated with the pipeline. ...@@ -2699,7 +2726,9 @@ New tags use the SHA associated with the pipeline.
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: A tag name. Can use [CI/CD variables](../variables/index.md). **Possible inputs**:
- A tag name. Can use [CI/CD variables](../variables/index.md).
**Example of `release:tag_name`**: **Example of `release:tag_name`**:
...@@ -2738,7 +2767,9 @@ The release name. If omitted, it is populated with the value of `release: tag_na ...@@ -2738,7 +2767,9 @@ The release name. If omitted, it is populated with the value of `release: tag_na
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: A text string. **Possible inputs**:
- A text string.
**Example of `release:name`**: **Example of `release:name`**:
...@@ -2843,8 +2874,10 @@ can be deployed to, but only one deployment can occur per device at any given ti ...@@ -2843,8 +2874,10 @@ can be deployed to, but only one deployment can occur per device at any given ti
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: Only letters, digits, `-`, `_`, `/`, `$`, `{`, `}`, `.`, and spaces. **Possible inputs**:
It can't start or end with `/`.
- Only letters, digits, `-`, `_`, `/`, `$`, `{`, `}`, `.`, and spaces.
It can't start or end with `/`.
**Example of `resource_group`**: **Example of `resource_group`**:
...@@ -2875,7 +2908,9 @@ to select which failures to retry on. ...@@ -2875,7 +2908,9 @@ to select which failures to retry on.
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: `0` (default), `1`, or `2`. **Possible inputs**:
- `0` (default), `1`, or `2`.
**Example of `retry`**: **Example of `retry`**:
...@@ -2894,7 +2929,9 @@ Use `retry:when` with `retry:max` to retry jobs for only specific failure cases. ...@@ -2894,7 +2929,9 @@ Use `retry:when` with `retry:max` to retry jobs for only specific failure cases.
**Keyword type**: Job keyword. You can use it only as part of a job or in the **Keyword type**: Job keyword. You can use it only as part of a job or in the
[`default` section](#default). [`default` section](#default).
**Possible inputs**: A single failure type, or an array of one or more failure types: **Possible inputs**:
- A single failure type, or an array of one or more failure types:
<!-- <!--
If you change any of the values below, make sure to update the `RETRY_WHEN_IN_DOCUMENTATION` If you change any of the values below, make sure to update the `RETRY_WHEN_IN_DOCUMENTATION`
...@@ -3002,7 +3039,9 @@ or [custom CI/CD variables](../variables/index.md#custom-cicd-variables). ...@@ -3002,7 +3039,9 @@ or [custom CI/CD variables](../variables/index.md#custom-cicd-variables).
**Keyword type**: Job-specific and pipeline-specific. You can use it as part of a job **Keyword type**: Job-specific and pipeline-specific. You can use it as part of a job
to configure the job behavior, or with [`workflow`](#workflow) to configure the pipeline behavior. to configure the job behavior, or with [`workflow`](#workflow) to configure the pipeline behavior.
**Possible inputs**: A [CI/CD variable expression](../jobs/job_control.md#cicd-variable-expressions). **Possible inputs**:
- A [CI/CD variable expression](../jobs/job_control.md#cicd-variable-expressions).
**Example of `rules:if`**: **Example of `rules:if`**:
...@@ -3048,8 +3087,9 @@ branch or merge request pipelines. ...@@ -3048,8 +3087,9 @@ branch or merge request pipelines.
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: An array of file paths. In GitLab 13.6 and later, **Possible inputs**:
[file paths can include variables](../jobs/job_control.md#variables-in-ruleschanges).
- An array of file paths. In GitLab 13.6 and later, [file paths can include variables](../jobs/job_control.md#variables-in-ruleschanges).
**Example of `rules:changes`**: **Example of `rules:changes`**:
...@@ -3083,8 +3123,10 @@ Use `exists` to run a job when certain files exist in the repository. ...@@ -3083,8 +3123,10 @@ Use `exists` to run a job when certain files exist in the repository.
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: An array of file paths. Paths are relative to the project directory (`$CI_PROJECT_DIR`) **Possible inputs**:
and can't directly link outside it. File paths can use glob patterns.
- An array of file paths. Paths are relative to the project directory (`$CI_PROJECT_DIR`)
and can't directly link outside it. File paths can use glob patterns.
**Example of `rules:exists`**: **Example of `rules:exists`**:
...@@ -3122,7 +3164,9 @@ job to run before continuing. ...@@ -3122,7 +3164,9 @@ job to run before continuing.
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: `true` or `false`. Defaults to `false` if not defined. **Possible inputs**:
- `true` or `false`. Defaults to `false` if not defined.
**Example of `rules:allow_failure`**: **Example of `rules:allow_failure`**:
...@@ -3151,7 +3195,9 @@ Use [`variables`](#variables) in `rules` to define variables for specific condit ...@@ -3151,7 +3195,9 @@ Use [`variables`](#variables) in `rules` to define variables for specific condit
**Keyword type**: Job-specific. You can use it only as part of a job. **Keyword type**: Job-specific. You can use it only as part of a job.
**Possible inputs**: A hash of variables in the format `VARIABLE-NAME: value`. **Possible inputs**:
- A hash of variables in the format `VARIABLE-NAME: value`.
**Example of `rules:variables`**: **Example of `rules:variables`**:
...@@ -3286,7 +3332,9 @@ the secret value directly in the variable. ...@@ -3286,7 +3332,9 @@ the secret value directly in the variable.
**Keyword type**: Job keyword. You can use it only as part of a job. **Keyword type**: Job keyword. You can use it only as part of a job.
**Possible inputs**: `true` (default) or `false`. **Possible inputs**:
- `true` (default) or `false`.
**Example of `secrets:file`**: **Example of `secrets:file`**:
...@@ -3682,7 +3730,9 @@ Must be used with `value`, for the variable value. ...@@ -3682,7 +3730,9 @@ Must be used with `value`, for the variable value.
**Keyword type**: Global keyword. You cannot set job-level variables to be pre-filled when you run a pipeline manually. **Keyword type**: Global keyword. You cannot set job-level variables to be pre-filled when you run a pipeline manually.
**Possible inputs**: A string. **Possible inputs**:
- A string.
**Example of `variables:description`**: **Example of `variables:description`**:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment