diff options
Diffstat (limited to 'doc/ci/pipelines')
| -rw-r--r-- | doc/ci/pipelines/index.md | 6 | ||||
| -rw-r--r-- | doc/ci/pipelines/job_artifacts.md | 43 | ||||
| -rw-r--r-- | doc/ci/pipelines/pipeline_architectures.md | 16 | ||||
| -rw-r--r-- | doc/ci/pipelines/settings.md | 14 |
4 files changed, 47 insertions, 32 deletions
diff --git a/doc/ci/pipelines/index.md b/doc/ci/pipelines/index.md index 48aaebc3456..18b3fe10bec 100644 --- a/doc/ci/pipelines/index.md +++ b/doc/ci/pipelines/index.md @@ -348,17 +348,17 @@ For example, these three jobs will be in a group named `build ruby`: build ruby 1/3: stage: build script: - - echo "ruby1" + - echo "ruby1" build ruby 2/3: stage: build script: - - echo "ruby2" + - echo "ruby2" build ruby 3/3: stage: build script: - - echo "ruby3" + - echo "ruby3" ``` In the pipeline, the result is a group named `build ruby` with three jobs: diff --git a/doc/ci/pipelines/job_artifacts.md b/doc/ci/pipelines/job_artifacts.md index 1d60f412e5e..c4457d17dc2 100644 --- a/doc/ci/pipelines/job_artifacts.md +++ b/doc/ci/pipelines/job_artifacts.md @@ -33,7 +33,7 @@ pdf: script: xelatex mycv.tex artifacts: paths: - - mycv.pdf + - mycv.pdf expire_in: 1 week ``` @@ -87,8 +87,8 @@ Below is an example of collecting a JUnit XML file from Ruby's RSpec test tool: rspec: stage: test script: - - bundle install - - rspec --format RspecJunitFormatter --out rspec.xml + - bundle install + - rspec --format RspecJunitFormatter --out rspec.xml artifacts: reports: junit: rspec.xml @@ -114,14 +114,15 @@ The `dotenv` report collects a set of environment variables as artifacts. The collected variables are registered as runtime-created variables of the job, which is useful to [set dynamic environment URLs after a job finishes](../environments/index.md#set-dynamic-environment-urls-after-a-job-finishes). -There are a couple of limitations on top of the [original dotenv rules](https://github.com/motdotla/dotenv#rules). +There are a couple of exceptions to the [original dotenv rules](https://github.com/motdotla/dotenv#rules): -- The variable key can contain only letters, digits and underscore ('_'). -- The size of the dotenv file must be smaller than 5 kilobytes. -- The number of variables must be less than 10. -- It does not support variable substitution in the dotenv file itself. -- It does not support empty lines and comments (`#`) in dotenv file. -- It does not support quote escape, spaces in a quote, a new line expansion in a quote, in dotenv file. +- The variable key can contain only letters, digits, and underscores (`_`). +- The maximum size of the `.env` file is 5 KB. +- The maximum number of variables is 10. +- Variable substitution in the `.env` file is not supported. +- The `.env` file can't have empty lines or comments (starting with `#`). +- Key values in the `env` file cannot have spaces or newline characters (`\n`), including when using single or double quotes. +- Quote escaping during parsing (`key = 'value'` -> `{key: "value"}`) is not supported. #### `artifacts:reports:cobertura` @@ -145,9 +146,10 @@ plan report will be uploaded to GitLab as an artifact and will be automatically in merge requests. For more information, see [Output `terraform plan` information into a merge request](../../user/infrastructure/index.md#output-terraform-plan-information-into-a-merge-request). -#### `artifacts:reports:codequality` **(STARTER)** +#### `artifacts:reports:codequality` -> - Introduced in GitLab 11.5. +> - Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 11.5. +> - Made [available in all tiers](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) in GitLab 13.2. > - Requires GitLab Runner 11.5 and above. The `codequality` report collects [CodeQuality issues](../../user/project/merge_requests/code_quality.md) @@ -250,12 +252,23 @@ dashboards. > - Introduced in GitLab 11.5. > - Requires GitLab Runner 11.5 and above. -The `performance` report collects [Performance metrics](../../user/project/merge_requests/browser_performance_testing.md) +The `performance` report collects [Browser Performance Testing metrics](../../user/project/merge_requests/browser_performance_testing.md) as artifacts. -The collected Performance report will be uploaded to GitLab as an artifact and will +The collected Browser Performance report will be uploaded to GitLab as an artifact and will be automatically shown in merge requests. +#### `artifacts:reports:load_performance` **(PREMIUM)** + +> - Introduced in [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35260) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.2. +> - Requires GitLab Runner 11.5 and above. + +The `load_performance` report collects [Load Performance Testing metrics](../../user/project/merge_requests/load_performance_testing.md) +as artifacts. + +The report is uploaded to GitLab as an artifact and is +shown in merge requests automatically. + #### `artifacts:reports:metrics` **(PREMIUM)** > Introduced in GitLab 11.10. @@ -407,7 +420,7 @@ information in the UI. ## Erasing artifacts -DANGER: **Warning:** +DANGER: **Danger:** This is a destructive action that leads to data loss. Use with caution. You can erase a single job via the UI, which will also remove the job's diff --git a/doc/ci/pipelines/pipeline_architectures.md b/doc/ci/pipelines/pipeline_architectures.md index 9176444660d..ace765ddb41 100644 --- a/doc/ci/pipelines/pipeline_architectures.md +++ b/doc/ci/pipelines/pipeline_architectures.md @@ -133,28 +133,28 @@ build_b: test_a: stage: test - needs: build_a + needs: [build_a] script: - echo "This test job will start as soon as build_a finishes." - echo "It will not wait for build_b, or other jobs in the build stage, to finish." test_b: stage: test - needs: build_b + needs: [build_b] script: - echo "This test job will start as soon as build_b finishes." - echo "It will not wait for other jobs in the build stage to finish." deploy_a: stage: deploy - needs: test_a + needs: [test_a] script: - echo "Since build_a and test_a run quickly, this deploy job can run much earlier." - echo "It does not need to wait for build_b or test_b." deploy_b: stage: deploy - needs: test_b + needs: [test_b] script: - echo "Since build_b and test_b run slowly, this deploy job will run much later." ``` @@ -228,13 +228,13 @@ build_a: test_a: stage: test - needs: build_a + needs: [build_a] script: - echo "This job tests something." deploy_a: stage: deploy - needs: test_a + needs: [test_a] script: - echo "This job deploys something." ``` @@ -257,13 +257,13 @@ build_b: test_b: stage: test - needs: build_b + needs: [build_b] script: - echo "This job tests something else." deploy_b: stage: deploy - needs: test_b + needs: [test_b] script: - echo "This job deploys something else." ``` diff --git a/doc/ci/pipelines/settings.md b/doc/ci/pipelines/settings.md index 2c9d4ccf2c4..39acef14443 100644 --- a/doc/ci/pipelines/settings.md +++ b/doc/ci/pipelines/settings.md @@ -36,7 +36,7 @@ in `.gitlab-ci.yml`. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/28919) in GitLab 12.0. -NOTE: **Note**: +NOTE: **Note:** As of GitLab 12.0, newly created projects will automatically have a default `git depth` value of `50`. @@ -283,7 +283,7 @@ Markdown code will embed the test coverage report badge of the `coverage` job into your `README.md`: ```markdown - + ``` ### Badge styles @@ -296,7 +296,7 @@ Pipeline badges can be rendered in different styles by adding the `style=style_n https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat ``` - + #### Flat square @@ -306,17 +306,19 @@ https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?st https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat-square ``` - + ### Custom badge text +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17555) in GitLab 13.1. + The text for a badge can be customized. This can be useful to differentiate between multiple coverage jobs that run in the same pipeline. Customize the badge text and width by adding the `key_text=custom_text` and `key_width=custom_key_width` parameters to the URL: ```plaintext -https://gitlab.com/gitlab-org/gitlab-foss/badges/master/coverage.svg?job=karma&key_text=Frontend+Coverage&key_width=100 +https://gitlab.com/gitlab-org/gitlab/badges/master/coverage.svg?job=karma&key_text=Frontend+Coverage&key_width=100 ``` - + ## Environment Variables |