diff options
Diffstat (limited to 'doc/ci')
57 files changed, 1125 insertions, 910 deletions
diff --git a/doc/ci/README.md b/doc/ci/README.md index 9d3f7f2a8f2..dca6d8baa79 100644 --- a/doc/ci/README.md +++ b/doc/ci/README.md @@ -16,7 +16,7 @@ through the [continuous methodologies](introduction/index.md#introduction-to-cic - Continuous Delivery (CD) - Continuous Deployment (CD) -NOTE: **Note:** +TIP: **Tip:** Out-of-the-box management systems can decrease hours spent on maintaining toolchains by 10% or more. Watch our ["Mastering continuous software development"](https://about.gitlab.com/webcast/mastering-ci-cd/) webcast to learn about continuous methods and how GitLab’s built-in CI can help you simplify and scale software development. @@ -24,7 +24,7 @@ webcast to learn about continuous methods and how GitLab’s built-in CI can hel ## Overview Continuous Integration works by pushing small code chunks to your -application's code base hosted in a Git repository, and, to every +application's codebase hosted in a Git repository, and to every push, run a pipeline of scripts to build, test, and validate the code changes before merging them into the main branch. @@ -73,13 +73,14 @@ to your needs:  +While building your `.gitlab-ci.yml`, you can use the [CI/CD configuration visualization](yaml/visualization.md) to facilate your writing experience. + For a broader overview, see the [CI/CD getting started](quick_start/README.md) guide. Once you're familiar with how GitLab CI/CD works, see the [`.gitlab-ci.yml` full reference](yaml/README.md) for all the attributes you can set and use. -NOTE: **Note:** GitLab CI/CD and [shared runners](runners/README.md#shared-runners) are enabled on GitLab.com and available for all users, limited only by the [pipeline quota](../user/gitlab_com/index.md#shared-runners). ## Concepts @@ -94,7 +95,7 @@ GitLab CI/CD uses a number of concepts to describe and run your build and deploy | [Job artifacts](pipelines/job_artifacts.md) | Output, use, and reuse job artifacts. | | [Cache dependencies](caching/index.md) | Cache your dependencies for a faster execution. | | [GitLab Runner](https://docs.gitlab.com/runner/) | Configure your own runners to execute your scripts. | -| [Pipeline efficiency](pipelines/pipeline_efficiency.md) | Configure your pipelines to run quickly and effienctly. | +| [Pipeline efficiency](pipelines/pipeline_efficiency.md) | Configure your pipelines to run quickly and efficiently. | ## Configuration diff --git a/doc/ci/caching/index.md b/doc/ci/caching/index.md index 50f7d5252d8..df41f7da2d9 100644 --- a/doc/ci/caching/index.md +++ b/doc/ci/caching/index.md @@ -24,7 +24,6 @@ how it is defined in `.gitlab-ci.yml`. ## Cache vs artifacts -NOTE: **Note:** Be careful if you use cache and artifacts to store the same path in your jobs as **caches are restored before artifacts** and the content could be overwritten. @@ -73,7 +72,6 @@ Artifacts: - Are always uploaded to GitLab (known as coordinator). - Can have an expiration value for controlling disk usage (30 days by default). -NOTE: **Note:** Both artifacts and caches define their paths relative to the project directory, and can't link to files outside it. @@ -204,9 +202,7 @@ runs of jobs for things like dependencies and commonly used libraries (Node.js packages, PHP packages, rubygems, Python libraries, etc.), so they don't have to be re-fetched from the public internet. -NOTE: **Note:** -For more examples, check out our [GitLab CI/CD -templates](https://gitlab.com/gitlab-org/gitlab/tree/master/lib/gitlab/ci/templates). +For more examples, check out our [GitLab CI/CD templates](https://gitlab.com/gitlab-org/gitlab/tree/master/lib/gitlab/ci/templates). ### Caching Node.js dependencies diff --git a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md index 74c48f087b2..f8e2a2b7eb0 100644 --- a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md +++ b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md @@ -9,7 +9,7 @@ type: howto GitLab CI/CD can be used with Bitbucket Cloud by: -1. Creating a [CI/CD project](../../user/project/ci_cd_for_external_repo.md). +1. Creating a [CI/CD project](index.md). 1. Connecting your Git repository via URL. To use GitLab CI/CD with a Bitbucket Cloud repository: diff --git a/doc/ci/ci_cd_for_external_repos/github_integration.md b/doc/ci/ci_cd_for_external_repos/github_integration.md index 661d935fc1d..7ee9f98bd39 100644 --- a/doc/ci/ci_cd_for_external_repos/github_integration.md +++ b/doc/ci/ci_cd_for_external_repos/github_integration.md @@ -21,7 +21,6 @@ cannot be used to authenticate with GitHub as an external CI/CD repository. ## Connect with Personal Access Token -NOTE: **Note:** Personal access tokens can only be used to connect GitHub.com repositories to GitLab, and the GitHub user must have the [owner role](https://docs.github.com/en/github/getting-started-with-github/access-permissions-on-github). @@ -53,7 +52,6 @@ GitLab will: ## Connect manually -NOTE: **Note:** To use **GitHub Enterprise** with **GitLab.com**, use this method. To manually enable GitLab CI/CD for your repository: diff --git a/doc/ci/ci_cd_for_external_repos/index.md b/doc/ci/ci_cd_for_external_repos/index.md index 78988e8a057..c6590599849 100644 --- a/doc/ci/ci_cd_for_external_repos/index.md +++ b/doc/ci/ci_cd_for_external_repos/index.md @@ -74,7 +74,6 @@ If changes are pushed to the branch referenced by the Pull Request and the Pull Request is still open, a pipeline for the external pull request is created. -NOTE: **Note:** GitLab CI/CD will create 2 pipelines in this case. One for the branch push and one for the external pull request. diff --git a/doc/ci/cloud_deployment/index.md b/doc/ci/cloud_deployment/index.md index 6fa0e6d9475..af7df0e1153 100644 --- a/doc/ci/cloud_deployment/index.md +++ b/doc/ci/cloud_deployment/index.md @@ -8,7 +8,10 @@ type: howto # Cloud deployment Interacting with a major cloud provider may have become a much needed task that's -part of your delivery process. GitLab is making this process less painful by providing Docker images +part of your delivery process. With GitLab you can +[deploy your application anywhere](https://about.gitlab.com/stages-devops-lifecycle/deploy-targets/). + +For some specific deployment targets, GitLab makes this process less painful by providing Docker images that come with the needed libraries and tools pre-installed. By referencing them in your CI/CD pipeline, you'll be able to interact with your chosen cloud provider more easily. @@ -200,3 +203,81 @@ deploy: script: - aws ecs register-task-definition ... ``` + +### Provision and deploy to your AWS Elastic Compute Cloud (EC2) + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201742) in GitLab 13.5. + +You can use the `AWS/CF-Provision-and-Deploy-EC2` CI template to perform the +following actions within the same pipeline: + +1. **Create stack**: Provision your own infrastructure by leveraging the [AWS CloudFormation](https://aws.amazon.com/cloudformation/) API. +1. **Push to S3**: Push your previously-built artifact to an [AWS S3](https://aws.amazon.com/s3/) bucket. +1. **Deploy to EC2**: Deploy this pushed content onto an [AWS EC2](https://aws.amazon.com/ec2/) instance. + + + +#### Run the `AWS/CF-Provision-and-Deploy-EC2.gitlab-ci.yml` template + +To run the `AWS/CF-Provision-and-Deploy-EC2.gitlab-ci.yml` template, you must +pass three JSON input objects, based on existing templates: + +1. The AWS documentation provides templates for the _Create stack_ and _Deploy to EC2_ steps (links + below). We provide the template for the remaining step, _Push to S3_: + + - [Template for the _Create stack_ step on AWS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html). + - Template for the _Push to S3_ step. Note that `source` is where a preceding `build` job built + your application, exporting the build through [`artifacts:paths`](../yaml/README.md#artifactspaths): + + ```json + { + "applicationName": "string", + "source": "string", + "s3Location": "s3://your/bucket/project_built_file...]" + } + ``` + + - [Template for the _Deploy to EC2_ step on AWS](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html). + +1. Once you have completed these three templates based on your requirements, you + have two ways to pass in these JSON objects: + + - They can be three actual files located in your project. You must specify their path relative to + your project root in your `.gitlab-ci.yml` file, using the following variables. For example, if + your files are in a `<project_root>/aws` folder: + + ```yaml + variables: + CI_AWS_CF_CREATE_STACK_FILE: 'aws/cf_create_stack.json' + CI_AWS_S3_PUSH_FILE: 'aws/s3_push.json' + CI_AWS_EC2_DEPLOYMENT_FILE: 'aws/create_deployment.json' + ``` + + - Alternatively, you can provide these JSON objects as [file-typed environment variables](../variables/README.md#custom-environment-variables-of-type-file). + In your project, go to **Settings > CI / CD > Variables** and add + the three variables listed above as file-typed environment variables. + For each variable, set the value to its corresponding JSON object. + +1. Provide the name of the stack you're creating and/or targeting, as an environment variable: + + ```yaml + variables: + CI_AWS_CF_STACK_NAME: 'YourStackName' + ``` + +1. Add this CI template to your `.gitlab-ci.yml`: + + ```yaml + include: + - template: AWS/CF-Provision-and-Deploy-EC2.gitlab-ci.yml + ``` + +When running your project pipeline at this point: + +- Your AWS CloudFormation stack is created based on the content of your + `CI_AWS_CF_CREATE_STACK_FILE` file/variable. + If your stack already exists, this step is skipped, but the `provision` job it belongs to still + runs. +- Your built application is pushed to your S3 bucket then and deployed to your EC2 instance, based + on the related JSON object's content. The deployment job finishes whenever the deployment to EC2 + is done or has failed. diff --git a/doc/ci/docker/using_docker_build.md b/doc/ci/docker/using_docker_build.md index 045fcd39c4d..e3123cde1cd 100644 --- a/doc/ci/docker/using_docker_build.md +++ b/doc/ci/docker/using_docker_build.md @@ -48,7 +48,6 @@ The simplest approach is to install GitLab Runner in `shell` execution mode. GitLab Runner then executes job scripts as the `gitlab-runner` user. 1. Install [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner/#installation). - 1. During GitLab Runner installation select `shell` as method of executing job scripts or use command: ```shell @@ -90,7 +89,6 @@ GitLab Runner then executes job scripts as the `gitlab-runner` user. 1. You can now use `docker` command (and **install** `docker-compose` if needed). -NOTE: **Note:** By adding `gitlab-runner` to the `docker` group you are effectively granting `gitlab-runner` full root permissions. For more information please read [On Docker security: `docker` group considered harmful](https://www.andreas-jung.com/contents/on-docker-security-docker-group-considered-harmful). @@ -101,7 +99,6 @@ The second approach is to use the special Docker-in-Docker (dind) (`docker`) and run the job script in context of that image in privileged mode. -NOTE: **Note:** `docker-compose` is not part of Docker-in-Docker (dind). To use `docker-compose` in your CI builds, follow the `docker-compose` [installation instructions](https://docs.docker.com/compose/install/). @@ -149,22 +146,17 @@ released. #### TLS enabled -NOTE: **Note:** -Requires GitLab Runner 11.11 or later, but is not supported if GitLab -Runner is installed using the [Helm -chart](https://docs.gitlab.com/runner/install/kubernetes.html). See the -[related -issue](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/issues/83) for -details. - The Docker daemon supports connection over TLS and it's done by default for Docker 19.03.12 or higher. This is the **suggested** way to use the Docker-in-Docker service and [GitLab.com shared runners](../../user/gitlab_com/index.md#shared-runners) support this. -1. Install [GitLab Runner](https://docs.gitlab.com/runner/install/). +GitLab Runner 11.11 or later is required, but it is not supported if GitLab +Runner is installed using the [Helm chart](https://docs.gitlab.com/runner/install/kubernetes.html). +See the [related issue](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/issues/83) for details. +1. Install [GitLab Runner](https://docs.gitlab.com/runner/install/). 1. Register GitLab Runner from the command line to use `docker` and `privileged` mode: @@ -225,7 +217,7 @@ support this. # The 'docker' hostname is the alias of the service container as described at # https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#accessing-the-services. # - # Note that if you're using GitLab Runner 12.7 or earlier with the Kubernetes executor and Kubernetes 1.6 or earlier, + # If you're using GitLab Runner 12.7 or earlier with the Kubernetes executor and Kubernetes 1.6 or earlier, # the variable must be set to tcp://localhost:2376 because of how the # Kubernetes executor connects services to the job container # DOCKER_HOST: tcp://localhost:2376 @@ -287,7 +279,7 @@ variables: # The 'docker' hostname is the alias of the service container as described at # https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#accessing-the-services # - # Note that if you're using GitLab Runner 12.7 or earlier with the Kubernetes executor and Kubernetes 1.6 or earlier, + # If you're using GitLab Runner 12.7 or earlier with the Kubernetes executor and Kubernetes 1.6 or earlier, # the variable must be set to tcp://localhost:2375 because of how the # Kubernetes executor connects services to the job container # DOCKER_HOST: tcp://localhost:2375 @@ -324,7 +316,6 @@ are done to the services as well, making these incompatible. In order to do that, follow the steps: 1. Install [GitLab Runner](https://docs.gitlab.com/runner/install/). - 1. Register GitLab Runner from the command line to use `docker` and share `/var/run/docker.sock`: ```shell @@ -506,14 +497,13 @@ environment = ["DOCKER_DRIVER=overlay2"] If you're running multiple runners, you have to modify all configuration files. -NOTE: **Note:** Read more about the [runner configuration](https://docs.gitlab.com/runner/configuration/) and [using the OverlayFS storage driver](https://docs.docker.com/engine/userguide/storagedriver/overlayfs-driver/). ## Using the GitLab Container Registry Once you've built a Docker image, you can push it up to the built-in -[GitLab Container Registry](../../user/packages/container_registry/index.md#build-and-push-images-using-gitlab-cicd). +[GitLab Container Registry](../../user/packages/container_registry/index.md#build-and-push-by-using-gitlab-cicd). ## Troubleshooting diff --git a/doc/ci/docker/using_docker_images.md b/doc/ci/docker/using_docker_images.md index 0fcd95c41ed..f7d54aa7d78 100644 --- a/doc/ci/docker/using_docker_images.md +++ b/doc/ci/docker/using_docker_images.md @@ -138,7 +138,6 @@ still succeeds even if that warning was printed. For example: As it was mentioned before, this feature is designed to provide **network accessible** services. A database is the simplest example of such a service. -NOTE: **Note:** The services feature is not designed to, and does not add any software from the defined `services` image(s) to the job's container. @@ -186,7 +185,6 @@ access to it from your build container under two hostnames to choose from: - `tutum-wordpress` - `tutum__wordpress` -NOTE: **Note:** Hostnames with underscores are not RFC valid and may cause problems in 3rd party applications. @@ -364,10 +362,9 @@ For example, the following two definitions are equal: | `name` | yes, when used with any other option | 9.4 | Full name of the image that should be used. It should contain the Registry part if needed. | | `entrypoint` | no | 9.4 |Command or script that should be executed as the container's entrypoint. It's translated to Docker's `--entrypoint` option while creating the container. The syntax is similar to [`Dockerfile`'s `ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, where each shell token is a separate string in the array. | | `command` | no | 9.4 |Command or script that should be used as the container's command. It's translated to arguments passed to Docker after the image's name. The syntax is similar to [`Dockerfile`'s `CMD`](https://docs.docker.com/engine/reference/builder/#cmd) directive, where each shell token is a separate string in the array. | -| `alias` | no | 9.4 |Additional alias that can be used to access the service from the job's container. Read [Accessing the services](#accessing-the-services) for more information. | +| `alias` (1) | no | 9.4 |Additional alias that can be used to access the service from the job's container. Read [Accessing the services](#accessing-the-services) for more information. | -NOTE: **Note:** -Alias support for the Kubernetes executor was [introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2229) in GitLab Runner 12.8, and is only available for Kubernetes version 1.7 or later. +(1) Alias support for the Kubernetes executor was [introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2229) in GitLab Runner 12.8, and is only available for Kubernetes version 1.7 or later. ### Starting multiple services from the same image @@ -532,7 +529,6 @@ To define which should be used, the GitLab Runner process reads the configuratio If the `--user` flag is provided to run the GitLab Runner child processes as unprivileged user, the home directory of the main GitLab Runner process user is used. -NOTE: **Note:** GitLab Runner reads this configuration **only** from `config.toml` and ignores it if it's provided as an environment variable. This is because GitLab Runner uses **only** `config.toml` configuration and does not interpolate **ANY** environment variables at @@ -547,6 +543,7 @@ runtime. at least version **1.8** if you want to use private registries. - Available for [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes.html) in GitLab Runner 13.1 and later. +- [Credentials Store](#using-credentials-store) and [Credential Helpers](#using-credential-helpers) require binaries to be added to the GitLab Runner's `$PATH`, and require access to do so. Therefore, these features are not available on shared runners or any other runner where the user does not have access to the environment where the runner is installed. ### Using statically-defined credentials @@ -600,7 +597,7 @@ There are two ways to determine the value of `DOCKER_AUTH_CONFIG`: Open a terminal and execute the following command: ```shell - # Note the use of "-n" - it prevents encoding a newline in the password. + # The use of "-n" - prevents encoding a newline in the password. echo -n "my_username:my_password" | base64 # Example output to copy @@ -650,7 +647,6 @@ follow these steps: You can add configuration for as many registries as you want, adding more registries to the `"auths"` hash as described above. -NOTE: **Note:** The full `hostname:port` combination is required everywhere for the runner to match the `DOCKER_AUTH_CONFIG`. For example, if `registry.example.com:5000/namespace/image:tag` is specified in `.gitlab-ci.yml`, @@ -679,17 +675,14 @@ To add `DOCKER_AUTH_CONFIG` to a runner: environment = ["DOCKER_AUTH_CONFIG={\"auths\":{\"registry.example.com:5000\":{\"auth\":\"bXlfdXNlcm5hbWU6bXlfcGFzc3dvcmQ=\"}}}"] ``` -1. Restart the runner service. - -NOTE: **Note:** -The double quotes included in the `DOCKER_AUTH_CONFIG` -data must be escaped with backslashes. This prevents them from being -interpreted as TOML. + - The double quotes included in the `DOCKER_AUTH_CONFIG` + data must be escaped with backslashes. This prevents them from being + interpreted as TOML. + - The `environment` option is a list. Your runner may + have existing entries and you should add this to the list, not replace + it. -NOTE: **Note:** -The `environment` option is a list. So your runner may -have existing entries and you should add this to the list, not replace -it. +1. Restart the runner service. ### Using Credentials Store @@ -717,10 +710,9 @@ To configure credentials store, follow these steps: `${GITLAB_RUNNER_HOME}/.docker/config.json`. GitLab Runner reads this configuration file and uses the needed helper for this specific repository. -NOTE: **Note:** `credsStore` is used to access ALL the registries. -If you want to use both images from private registry and public images from DockerHub, -pulling from DockerHub would fail, because Docker daemon tries to use the same credentials for **ALL** the registries. +If you want to use both images from private registry and public images from Docker Hub, +pulling from Docker Hub would fail, because Docker daemon tries to use the same credentials for **ALL** the registries. ### Using Credential Helpers @@ -732,10 +724,8 @@ image which is private and requires you to log in into a private container regis To configure access for `aws_account_id.dkr.ecr.region.amazonaws.com`, follow these steps: 1. Make sure `docker-credential-ecr-login` is available in GitLab Runner's `$PATH`. - 1. Have any of the following [AWS credentials setup](https://github.com/awslabs/amazon-ecr-credential-helper#aws-credentials). Make sure that GitLab Runner can access the credentials. - 1. Make GitLab Runner use it. There are two ways to accomplish this. Either: - Create a [variable](../variables/README.md#gitlab-cicd-environment-variables) @@ -791,7 +781,6 @@ service containers. For all possible configuration variables check the documentation of each image provided in their corresponding Docker hub page. -NOTE: **Note:** All variables are passed to all services containers. It's not designed to distinguish which variable should go where. @@ -823,7 +812,6 @@ time. ## How to debug a job locally -NOTE: **Note:** The following commands are run without root privileges. You should be able to run Docker with your regular user account. diff --git a/doc/ci/docker/using_kaniko.md b/doc/ci/docker/using_kaniko.md index a62f4db4fe4..f9b09bada14 100644 --- a/doc/ci/docker/using_kaniko.md +++ b/doc/ci/docker/using_kaniko.md @@ -17,13 +17,13 @@ kaniko solves two problems with using the build](using_docker_build.md#use-docker-in-docker-workflow-with-docker-executor) method: - Docker-in-Docker requires [privileged mode](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) - in order to function, which is a significant security concern. + to function, which is a significant security concern. - Docker-in-Docker generally incurs a performance penalty and can be quite slow. ## Requirements -In order to utilize kaniko with GitLab, [a runner](https://docs.gitlab.com/runner/) -with one of the following executors is required: +To use kaniko with GitLab, [a runner](https://docs.gitlab.com/runner/) with one +of the following executors is required: - [Kubernetes](https://docs.gitlab.com/runner/executors/kubernetes.html). - [Docker](https://docs.gitlab.com/runner/executors/docker.html). diff --git a/doc/ci/enable_or_disable_ci.md b/doc/ci/enable_or_disable_ci.md index 46cf76637a4..8b88ec509e7 100644 --- a/doc/ci/enable_or_disable_ci.md +++ b/doc/ci/enable_or_disable_ci.md @@ -31,7 +31,6 @@ either: - Site-wide by modifying the settings in `gitlab.yml` and `gitlab.rb` for source and Omnibus installations respectively. -NOTE: **Note:** This only applies to pipelines run as part of GitLab CI/CD. This will not enable or disable pipelines that are run from an [external integration](../user/project/integrations/overview.md#integrations-listing). diff --git a/doc/ci/environments/index.md b/doc/ci/environments/index.md index 07d0dac6163..baf2156e64a 100644 --- a/doc/ci/environments/index.md +++ b/doc/ci/environments/index.md @@ -118,11 +118,9 @@ With this configuration, we: - Ensure that our app is able to be built successfully. - Lastly we deploy to the staging server. -NOTE: **Note:** -The `environment` keyword defines where the app is deployed. -The environment `name` and `url` is exposed in various places -within GitLab. Each time a job that has an environment specified -succeeds, a deployment is recorded, along with the Git SHA, and environment name. +Note that the `environment` keyword defines where the app is deployed. The environment `name` and +`url` is exposed in various places within GitLab. Each time a job that has an environment specified +succeeds, a deployment is recorded along with the Git SHA and environment name. CAUTION: **Caution:** Some characters are not allowed in environment names. Use only letters, @@ -288,12 +286,11 @@ You can find the "play" button in the pipelines, environments, deployments, and | Deployments |  | | Jobs |  | -Clicking on the play button in any view will trigger the `deploy_prod` job, and the -deployment will be recorded as a new environment named `production`. +Clicking the play button in any view triggers the `deploy_prod` job. The deployment is recorded as a +new environment named `production`. -NOTE: **Note:** -If your environment's name is `production` (all lowercase), -it will get recorded in [Value Stream Analytics](../../user/project/cycle_analytics.md). +If your environment's name is `production` (all lowercase), it's recorded in +[Value Stream Analytics](../../user/analytics/value_stream_analytics.md). ### Configuring dynamic environments @@ -371,9 +368,8 @@ For the value of: the example above: `https://$CI_COMMIT_REF_NAME.example.com`, which would give a URL of `https://100-do-the-thing.example.com`. -NOTE: **Note:** -You are not required to use the same prefix or only slashes (`/`) in the dynamic environments' -names. However, using this format will enable the [grouping similar environments](#grouping-similar-environments) +You aren't required to use the same prefix or only slashes (`/`) in the dynamic environments' names. +However, using this format enables the [grouping similar environments](#grouping-similar-environments) feature. ### Configuring Kubernetes deployments @@ -384,6 +380,12 @@ If you are deploying to a [Kubernetes cluster](../../user/project/clusters/index associated with your project, you can configure these deployments from your `gitlab-ci.yml` file. +NOTE: **Note:** +Kubernetes configuration isn't supported for Kubernetes clusters that are +[managed by GitLab](../../user/project/clusters/index.md#gitlab-managed-clusters). +To follow progress on support for GitLab-managed clusters, see the +[relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/38054). + The following configuration options are supported: - [`namespace`](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) @@ -411,12 +413,6 @@ trace on the deployment job page:  -NOTE: **Note:** -Kubernetes configuration is not supported for Kubernetes clusters -that are [managed by GitLab](../../user/project/clusters/index.md#gitlab-managed-clusters). -To follow progress on support for GitLab-managed clusters, see the -[relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/38054). - #### Configuring incremental rollouts Learn how to release production changes to only a portion of your Kubernetes pods with @@ -514,9 +510,8 @@ review_app: This example requires that NGINX and GitLab Runner are set up on the server this job will run on. -NOTE: **Note:** -See the [limitations](#limitations) section for some edge cases regarding the naming of -your branches and Review Apps. +See the [limitations](#limitations) section for some edge cases regarding the naming of your +branches and Review Apps. The complete example provides the following workflow to developers: @@ -617,13 +612,12 @@ To retry or rollback a deployment: #### What to expect with a rollback -Pressing the **Rollback** button on a specific commit will trigger a _new_ deployment with its -own unique job ID. - -This means that you will see a new deployment that points to the commit you are rolling back to. +Pressing the **Rollback** button on a specific commit triggers a _new_ deployment with its own +unique job ID. This means that you will see a new deployment that points to the commit you're +rolling back to. -NOTE: **Note:** -The defined deployment process in the job's `script` determines whether the rollback succeeds or not. +Note that the defined deployment process in the job's `script` determines whether the rollback +succeeds. ### Using the environment URL @@ -662,9 +656,8 @@ Stopping an environment: This is often used when multiple developers are working on a project at the same time, each of them pushing to their own branches, causing many dynamic environments to be created. -NOTE: **Note:** -Starting with GitLab 8.14, dynamic environments are stopped automatically -when their associated branch is deleted. +Starting with GitLab 8.14, dynamic environments stop automatically when their associated branch is +deleted. #### Automatically stopping an environment @@ -721,29 +714,25 @@ You can read more in the [`.gitlab-ci.yml` reference](../yaml/README.md#environm > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/20956) in GitLab 12.8. -You can set a expiry time to environments and stop them automatically after a certain period. +You can set an expiry time for environments and stop them automatically after a certain period. -For example, consider the use of this feature with Review Apps environments. -When you set up Review Apps, sometimes they keep running for a long time -because some merge requests are left as open. An example for this situation is when the author of the merge -request is not actively working on it, due to priority changes or a different approach was decided on, and the merge requests was simply forgotten. -Idle environments waste resources, therefore they -should be terminated as soon as possible. +For example, consider the use of this feature with Review App environments. When you set up Review +Apps, sometimes they keep running for a long time because some merge requests are left open and +forgotten. Such idle environments waste resources and should be terminated as soon as possible. -To address this problem, you can specify an optional expiration date for -Review Apps environments. When the expiry time is reached, GitLab will automatically trigger a job -to stop the environment, eliminating the need of manually doing so. In case an environment is updated, the expiration is renewed -ensuring that only active merge requests keep running Review Apps. +To address this problem, you can specify an optional expiration date for Review App environments. +When the expiry time is reached, GitLab automatically triggers a job to stop the environment, +eliminating the need of manually doing so. In case an environment is updated, the expiration is +renewed ensuring that only active merge requests keep running Review Apps. -To enable this feature, you need to specify the [`environment:auto_stop_in`](../yaml/README.md#environmentauto_stop_in) keyword in `.gitlab-ci.yml`. -You can specify a human-friendly date as the value, such as `1 hour and 30 minutes` or `1 day`. -`auto_stop_in` uses the same format of [`artifacts:expire_in` docs](../yaml/README.md#artifactsexpire_in). +To enable this feature, you must specify the [`environment:auto_stop_in`](../yaml/README.md#environmentauto_stop_in) +keyword in `.gitlab-ci.yml`. You can specify a human-friendly date as the value, such as +`1 hour and 30 minutes` or `1 day`. `auto_stop_in` uses the same format of +[`artifacts:expire_in` docs](../yaml/README.md#artifactsexpire_in). -NOTE: **Note:** -Due to the resource limitation, a background worker for stopping environments only -runs once every hour. This means environments will not be stopped at the exact -timestamp as the specified period, but will be stopped when the hourly cron worker -detects expired environments. +Note that due to resource limitation, a background worker for stopping environments only runs once +every hour. This means that environments aren't stopped at the exact timestamp specified, but are +instead stopped when the hourly cron worker detects expired environments. ##### Auto-stop example @@ -866,7 +855,7 @@ exist, you should see something like: ### Environment incident management -You have successfuly setup a Continous Delivery/Deployment workflow in your project. +You have successfully setup a Continuous Delivery/Deployment workflow in your project. Production environments can go down unexpectedly, including for reasons outside of your own control. For example, issues with external dependencies, infrastructure, or human error can cause major issues with an environment. This could include: @@ -903,8 +892,7 @@ you can monitor the behavior of your app running in each environment. For the mo dashboard to appear, you need to Configure Prometheus to collect at least one [supported metric](../../user/project/integrations/prometheus_library/index.md). -NOTE: **Note:** -Since GitLab 9.2, all deployments to an environment are shown directly on the monitoring dashboard. +In GitLab 9.2 and later, all deployments to an environment are shown directly on the monitoring dashboard. Once configured, GitLab will attempt to retrieve [supported performance metrics](../../user/project/integrations/prometheus_library/index.md) for any environment that has had a successful deployment. If monitoring data was @@ -938,6 +926,11 @@ This is a powerful feature that allows you to debug issues without leaving the c of your web browser. To enable it, just follow the instructions given in the service integration documentation. +NOTE: **Note:** +Container-based deployments often lack basic tools (like an editor), and may +be stopped or restarted at any time. If this happens, you will lose all your +changes. Treat this as a debugging tool, not a comprehensive online IDE. + Once enabled, your environments will gain a "terminal" button:  @@ -961,14 +954,9 @@ by your deployment so you can: You can open multiple terminals to the same environment, they each get their own shell session and even a multiplexer like `screen` or `tmux`. -NOTE: **Note:** -Container-based deployments often lack basic tools (like an editor), and may -be stopped or restarted at any time. If this happens, you will lose all your -changes. Treat this as a debugging tool, not a comprehensive online IDE. - ### Check out deployments locally -Since GitLab 8.13, a reference in the Git repository is saved for each deployment, so +In GitLab 8.13 and later, a reference in the Git repository is saved for each deployment, so knowing the state of your current environments is only a `git fetch` away. In your Git configuration, append the `[remote "<your-remote>"]` block with an extra @@ -1024,9 +1012,8 @@ As you can see, you can use specific matching for selecting a particular environ and also use wildcard matching (`*`) for selecting a particular environment group, such as [Review Apps](../review_apps/index.md) (`review/*`). -NOTE: **Note:** -The most _specific_ spec takes precedence over the other wildcard matching. -In this case, `review/feature-1` spec takes precedence over `review/*` and `*` specs. +Note that the most _specific_ spec takes precedence over the other wildcard matching. In this case, +the `review/feature-1` spec takes precedence over `review/*` and `*` specs. ### Environments Dashboard **(PREMIUM)** diff --git a/doc/ci/environments/protected_environments.md b/doc/ci/environments/protected_environments.md index 5dda0cc81f6..87bced29906 100644 --- a/doc/ci/environments/protected_environments.md +++ b/doc/ci/environments/protected_environments.md @@ -9,8 +9,6 @@ type: concepts, howto > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6303) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.3. -## Overview - [Environments](../environments/index.md) can be used for different reasons: - Some of them are just for testing. diff --git a/doc/ci/examples/artifactory_and_gitlab/index.md b/doc/ci/examples/artifactory_and_gitlab/index.md index 2abb2cc1b0d..e2ee05923cd 100644 --- a/doc/ci/examples/artifactory_and_gitlab/index.md +++ b/doc/ci/examples/artifactory_and_gitlab/index.md @@ -23,10 +23,10 @@ We also assume that an Artifactory instance is available and reachable from the ## Create the simple Maven dependency -First of all, you need an application to work with: in this specific case we will -use a simple one, but it could be any Maven application. This will be the -dependency you want to package and deploy to Artifactory, in order to be -available to other projects. +First, you need an application to work with: in this specific case we'll use a +simple one, but it could be any Maven application. This will be the dependency +you want to package and deploy to Artifactory, to be available to other +projects. ### Prepare the dependency application @@ -58,7 +58,7 @@ The application is ready to use, but you need some additional steps to deploy it 1. Log in to Artifactory with your user's credentials. 1. From the main screen, click on the `libs-release-local` item in the **Set Me Up** panel. 1. Copy to clipboard the configuration snippet under the **Deploy** paragraph. -1. Change the `url` value in order to have it configurable via variables. +1. Change the `url` value to have it configurable by using variables. 1. Copy the snippet in the `pom.xml` file for your project, just after the `dependencies` section. The snippet should look like this: @@ -146,8 +146,9 @@ deploy: - master ``` -The runner will use the latest [Maven Docker image](https://hub.docker.com/_/maven/), which already contains all the tools and the dependencies you need to manage the project, -in order to run the jobs. +The runner uses the latest [Maven Docker image](https://hub.docker.com/_/maven/), +which contains all of the tools and dependencies needed to manage the project +and to run the jobs. Environment variables are set to instruct Maven to use the `homedir` of the repository instead of the user's home when searching for configuration and dependencies. diff --git a/doc/ci/examples/authenticating-with-hashicorp-vault/index.md b/doc/ci/examples/authenticating-with-hashicorp-vault/index.md index 73896547675..4a0ff2fa6ac 100644 --- a/doc/ci/examples/authenticating-with-hashicorp-vault/index.md +++ b/doc/ci/examples/authenticating-with-hashicorp-vault/index.md @@ -41,15 +41,14 @@ The JWT's payload looks like this: "nbf": 1585798372, # Not valid before "exp": 1585713886, # Expire at "sub": "job_1212", # Subject (job id) - "namespace_id": "1", - "namespace_path": "mygroup", - "project_id": "22", - "project_path": "mygroup/myproject", - "user_id": "42", - "user_login": "myuser", - "user_email": "myuser@example.com", - "pipeline_id": "1212", - "job_id": "1212", + "namespace_id": "1", # Use this to scope to group or user level namespace by id + "namespace_path": "mygroup", # Use this to scope to group or user level namespace by path + "project_id": "22", # + "project_path": "mygroup/myproject", # + "user_id": "42", # Id of the user executing the job + "user_email": "myuser@example.com", # Email of the user executing the job + "pipeline_id": "1212", # + "job_id": "1212", # "ref": "auto-deploy-2020-04-01", # Git ref for this job "ref_type": "branch", # Git ref type, branch or tag "ref_protected": "true" # true if this git ref is protected, false otherwise diff --git a/doc/ci/examples/end_to_end_testing_webdriverio/index.md b/doc/ci/examples/end_to_end_testing_webdriverio/index.md index 1f6c81a68aa..aa6e6f73a0d 100644 --- a/doc/ci/examples/end_to_end_testing_webdriverio/index.md +++ b/doc/ci/examples/end_to_end_testing_webdriverio/index.md @@ -9,7 +9,7 @@ type: tutorial [Review Apps](../../review_apps/index.md) are great: for every merge request (or branch, for that matter), the new code can be copied and deployed to a fresh production-like live -environment, making it incredibly low-effort to assess the impact of the changes. Thus, when we use a dependency manager like +environment, reducing the effort to assess the impact of changes. Thus, when we use a dependency manager like [Dependencies.io](https://www.dependencies.io/), it can submit a merge request with an updated dependency, and it will immediately be clear that the application can still be properly built and deployed. After all, you can _see_ it running! @@ -95,9 +95,10 @@ dependency upgrade did not break anything without even having to look at your we ## Running locally -We'll get to running the above test in CI/CD in a moment. When writing tests, however, it helps if -you do not have to wait for your pipelines to succeed in order to check whether they do what you -expect them to do. In other words, let's get it to run locally. +We'll get to running the above test in CI/CD in a moment. When writing tests, +however, it helps if you don't have to wait for your pipelines to succeed to +determine whether they do what you expect them to do. In other words, let's get +it to run locally. Make sure that your app is running locally. If you use Webpack, you can use [the Webpack Dev Server WebdriverIO plugin](https://www.npmjs.com/package/wdio-webpack-dev-server-service) diff --git a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md index 8927c5c3480..aaa34afeddf 100644 --- a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md +++ b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md @@ -143,7 +143,6 @@ Now, let's clone our repository on the server just to make sure the `deployer` u git clone git@gitlab.example.com:<USERNAME>/laravel-sample.git ``` -NOTE: **Note:** Answer **yes** if asked `Are you sure you want to continue connecting (yes/no)?`. It adds GitLab.com to the known hosts. @@ -167,7 +166,6 @@ server { } ``` -NOTE: **Note:** You may replace the app's name in `/var/www/app/current/public` with the folder name of your application. ## Setting up Envoy @@ -397,8 +395,6 @@ To be able to build, test, and deploy our app with GitLab CI/CD, we need to prep To do that, we'll use a Docker image which has the minimum requirements that a Laravel app needs to run. [There are other ways](../php.md#test-php-projects-using-the-docker-executor) to do that as well, but they may lead our builds run slowly, which is not what we want when there are faster options to use. -With Docker images our builds run incredibly faster! - ### Create a Container Image Let's create a [Dockerfile](https://gitlab.com/mehranrasulian/laravel-sample/blob/master/Dockerfile) in the root directory of our app with the following content: @@ -441,9 +437,11 @@ On your GitLab project repository navigate to the **Registry** tab.  -You may need to [enable Container Registry](../../../user/packages/container_registry/index.md#enable-the-container-registry-for-your-project) to your project to see this tab. You'll find it under your project's **Settings > General > Visibility, project features, permissions**. +You may need to enable the Container Registry for your project to see this tab. You'll find it under your project's **Settings > General > Visibility, project features, permissions**. -To start using Container Registry on our machine, we first need to login to the GitLab registry using our GitLab username and password: +To start using Container Registry on our machine, we first need to sign in to the GitLab registry using our GitLab username and password. +Make sure you have [Docker](https://docs.docker.com/engine/installation/) installed on our machine, +then run the following commands: ```shell docker login registry.gitlab.com @@ -457,14 +455,10 @@ docker build -t registry.gitlab.com/<USERNAME>/laravel-sample . docker push registry.gitlab.com/<USERNAME>/laravel-sample ``` -NOTE: **Note:** -To run the above commands, we first need to have [Docker](https://docs.docker.com/engine/installation/) installed on our machine. - Congratulations! You just pushed the first Docker image to the GitLab Registry, and if you refresh the page you should be able to see it:  -NOTE: **Note:** You can also [use GitLab CI/CD](https://about.gitlab.com/blog/2016/05/23/gitlab-container-registry/#use-with-gitlab-ci) to build and push your Docker images, rather than doing that on your machine. We'll use this image further down in the `.gitlab-ci.yml` configuration file to handle the process of testing and deploying our app. @@ -544,7 +538,6 @@ services: ... ``` -NOTE: **Note:** If you wish to test your app with different PHP versions and [database management systems](../../services/README.md), you can define different `image` and `services` keywords for each test job. #### Variables diff --git a/doc/ci/examples/php.md b/doc/ci/examples/php.md index ab6ff1dc177..699d04f632c 100644 --- a/doc/ci/examples/php.md +++ b/doc/ci/examples/php.md @@ -141,12 +141,11 @@ Of course, `my_php.ini` must be present in the root directory of your repository ## Test PHP projects using the Shell executor -The shell executor runs your job in a terminal session on your server. -Thus, in order to test your projects you first need to make sure that all -dependencies are installed. +The shell executor runs your job in a terminal session on your server. To test +your projects, you must first ensure that all dependencies are installed. -For example, in a VM running Debian 8 we first update the cache, then we -install `phpunit` and `php5-mysql`: +For example, in a VM running Debian 8, first update the cache, and then install +`phpunit` and `php5-mysql`: ```shell sudo apt-get update -y @@ -219,8 +218,8 @@ test:atoum: ### Using Composer The majority of the PHP projects use Composer for managing their PHP packages. -In order to execute Composer before running your tests, simply add the -following in your `.gitlab-ci.yml`: +To execute Composer before running your tests, add the following to your +`.gitlab-ci.yml`: ```yaml # Composer stores all downloaded packages in the vendor/ directory. @@ -243,14 +242,14 @@ before_script: ## Access private packages or dependencies If your test suite needs to access a private repository, you need to configure -[the SSH keys](../ssh_keys/README.md) in order to be able to clone it. +the [SSH keys](../ssh_keys/README.md) to be able to clone it. ## Use databases or other services -Most of the time you will need a running database in order for your tests to -run. If you are using the Docker executor you can leverage Docker's ability to -link to other containers. With GitLab Runner, this can be achieved by -defining a `service`. +Most of the time, you need a running database for your tests to be able to +run. If you're using the Docker executor, you can leverage Docker's ability to +link to other containers. With GitLab Runner, this can be achieved by defining +a `service`. This functionality is covered in [the CI services](../services/README.md) documentation. diff --git a/doc/ci/examples/test-and-deploy-ruby-application-to-heroku.md b/doc/ci/examples/test-and-deploy-ruby-application-to-heroku.md index 066c0cf214f..86c979c489c 100644 --- a/doc/ci/examples/test-and-deploy-ruby-application-to-heroku.md +++ b/doc/ci/examples/test-and-deploy-ruby-application-to-heroku.md @@ -68,7 +68,7 @@ First install [Docker Engine](https://docs.docker.com/installation/). To build this project you also need to have [GitLab Runner](https://docs.gitlab.com/runner/). You can use public runners available on `gitlab.com` or register your own. Start by -creating a template configuration file in order to pass complex configuration: +creating a template configuration file to pass complex configuration: ```shell cat > /tmp/test-config.template.toml << EOF diff --git a/doc/ci/examples/test_phoenix_app_with_gitlab_ci_cd/index.md b/doc/ci/examples/test_phoenix_app_with_gitlab_ci_cd/index.md index ab6a4d3f507..c62f0dec598 100644 --- a/doc/ci/examples/test_phoenix_app_with_gitlab_ci_cd/index.md +++ b/doc/ci/examples/test_phoenix_app_with_gitlab_ci_cd/index.md @@ -117,7 +117,6 @@ Generated hello_gitlab_ci app The database for HelloGitlabCi.Repo has been created ``` -NOTE: **Note:** Phoenix assumes that our PostgreSQL database will have a `postgres` user account with the correct permissions and a password of `postgres`. If it's not your case, check [Ecto's instructions](https://hexdocs.pm/ecto/Ecto.html#module-repositories). @@ -205,7 +204,6 @@ when running our Phoenix in our `localhost`. Without `.gitkeep`, Git will not upload this empty directory and we'll got an error when running our test on GitLab. - NOTE: **Note:** If we add a folder via the GitLab UI, GitLab itself will add the `.gitkeep` to that new dir. Now, let's run a local test and see if everything we did didn't break anything. diff --git a/doc/ci/img/cf_ec2_diagram_v13_5.png b/doc/ci/img/cf_ec2_diagram_v13_5.png Binary files differnew file mode 100644 index 00000000000..1d49790c7b9 --- /dev/null +++ b/doc/ci/img/cf_ec2_diagram_v13_5.png diff --git a/doc/ci/img/ci_lint.png b/doc/ci/img/ci_lint.png Binary files differindex e62de011293..fdc3868cdce 100644 --- a/doc/ci/img/ci_lint.png +++ b/doc/ci/img/ci_lint.png diff --git a/doc/ci/img/ci_lint_dry_run.png b/doc/ci/img/ci_lint_dry_run.png Binary files differindex 4092b66d534..61d6379f70e 100644 --- a/doc/ci/img/ci_lint_dry_run.png +++ b/doc/ci/img/ci_lint_dry_run.png diff --git a/doc/ci/img/gitlab_vault_workflow_v13_4.png b/doc/ci/img/gitlab_vault_workflow_v13_4.png Binary files differnew file mode 100644 index 00000000000..80d07362bf4 --- /dev/null +++ b/doc/ci/img/gitlab_vault_workflow_v13_4.png diff --git a/doc/ci/introduction/index.md b/doc/ci/introduction/index.md index db2749233e8..d1f3e449e5b 100644 --- a/doc/ci/introduction/index.md +++ b/doc/ci/introduction/index.md @@ -12,7 +12,7 @@ In this document, we'll present an overview of the concepts of Continuous Integr Continuous Delivery, and Continuous Deployment, as well as an introduction to GitLab CI/CD. -NOTE: **Note:** +TIP: **Tip:** Out-of-the-box management systems can decrease hours spent on maintaining toolchains by 10% or more. Watch our ["Mastering continuous software development"](https://about.gitlab.com/webcast/mastering-ci-cd/) webcast to learn about continuous methods and how GitLab’s built-in CI can help you simplify and scale software development. @@ -154,7 +154,7 @@ commits to a feature branch in a remote repository in GitLab, the CI/CD pipeline set for your project is triggered. By doing so, GitLab CI/CD: -- Runs automated scripts (sequential or parallel) to: +- Runs automated scripts (sequentially or in parallel) to: - Build and test your app. - Preview the changes per merge request with Review Apps, as you would see in your `localhost`. diff --git a/doc/ci/merge_request_pipelines/index.md b/doc/ci/merge_request_pipelines/index.md index 3ce62936168..cc0b4ac1f86 100644 --- a/doc/ci/merge_request_pipelines/index.md +++ b/doc/ci/merge_request_pipelines/index.md @@ -24,7 +24,6 @@ can run a pipeline for merge requests.  -NOTE: **Note:** If you use this feature with [merge when pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md), pipelines for merge requests take precedence over the other regular pipelines. @@ -125,8 +124,9 @@ Therefore: - Since `C` specifies that it should only run for merge requests, it will not run for any pipeline except a merge request pipeline. -This helps you avoid having to add the `only:` rule to all of your jobs -in order to make them always run. You can use this format to set up a Review App, helping to save resources. +This helps you avoid having to add the `only:` rule to all of your jobs to make +them always run. You can use this format to set up a Review App, helping to +save resources. #### Excluding certain branches diff --git a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md index dd08f9248f6..2330bdb4c7c 100644 --- a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md +++ b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md @@ -80,8 +80,8 @@ For more information, read the [documentation on Merge Trains](merge_trains/inde > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12996) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.3. -GitLab CI/CD can detect the presence of redundant pipelines, -and will cancel them automatically in order to conserve CI resources. +GitLab CI/CD can detect the presence of redundant pipelines, and cancels them +to conserve CI resources. When a user merges a merge request immediately within an ongoing merge train, the train will be reconstructed, as it will recreate the expected diff --git a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md index 1f88e8f832f..45cae49377f 100644 --- a/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md +++ b/doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md @@ -37,7 +37,6 @@ run. To add a merge request to a merge train, you need [permissions](../../../../user/permissions.md) to push to the target branch. -NOTE: **Note:** Each merge train can run a maximum of **twenty** pipelines in parallel. If more than twenty merge requests are added to the merge train, the merge requests will be queued until a slot in the merge train is free. There is no limit to the diff --git a/doc/ci/metrics_reports.md b/doc/ci/metrics_reports.md index 4f4471225a0..53e097760e6 100644 --- a/doc/ci/metrics_reports.md +++ b/doc/ci/metrics_reports.md @@ -9,8 +9,6 @@ type: reference > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9788) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.10. Requires GitLab Runner 11.10 and above. -## Overview - GitLab provides a lot of great reporting tools for [merge requests](../user/project/merge_requests/index.md) - [Unit test reports](unit_test_reports.md), [code quality](../user/project/merge_requests/code_quality.md), performance tests, etc. While JUnit is a great open framework for tests that "pass" or "fail", it is also important to see other types of metrics from a given change. You can configure your job to use custom Metrics Reports, and GitLab will display a report on the merge request so that it's easier and faster to identify changes without having to check the entire log. diff --git a/doc/ci/migration/jenkins.md b/doc/ci/migration/jenkins.md index 8dff99f7244..1130c11f472 100644 --- a/doc/ci/migration/jenkins.md +++ b/doc/ci/migration/jenkins.md @@ -23,7 +23,7 @@ that were able to quickly complete this migration: 1. Use the [Jenkins Wrapper](#jenkinsfile-wrapper) to temporarily maintain fragile Jenkins jobs. 1. Migrate the build and CI jobs and configure them to show results directly in your merge requests. They can use [Auto DevOps](../../topics/autodevops/index.md) as a starting point, and [customize](../../topics/autodevops/customize.md) or [decompose](../../topics/autodevops/customize.md#using-components-of-auto-devops) the configuration as needed. 1. Add [Review Apps](../review_apps/index.md). - 1. Migrate the deployment jobs using [cloud deployment templates](../cloud_deployment/index.md), adding [environments](../environments/index.md), and [deploy boards](../..//user/project/deploy_boards.md). + 1. Migrate the deployment jobs using [cloud deployment templates](../cloud_deployment/index.md), adding [environments](../environments/index.md), and [deploy boards](../../user/project/deploy_boards.md). 1. Work to unwrap any jobs still running with the use of the Jenkins wrapper. 1. Take stock of any common CI/CD job definitions then create and share [templates](#templates) for them. 1. Check the [pipeline efficiency documentation](../pipelines/pipeline_efficiency.md) @@ -83,7 +83,7 @@ There are some high level differences between the products worth mentioning: - You can control which jobs run in which cases, depending on how they are triggered, with the [`rules` syntax](../yaml/README.md#rules). -- GitLab [pipeline scheduling concepts](../pipelines/schedules.md) are also different than with Jenkins. +- GitLab [pipeline scheduling concepts](../pipelines/schedules.md) are also different from Jenkins. - You can reuse pipeline configurations using the [`include` keyword](../yaml/README.md#include) and [templates](#templates). Your templates can be kept in a central repository (with different permissions), and then any project can use them. This central project could also diff --git a/doc/ci/multi_project_pipelines.md b/doc/ci/multi_project_pipelines.md index 3f9a00b6cc8..378adcd35e9 100644 --- a/doc/ci/multi_project_pipelines.md +++ b/doc/ci/multi_project_pipelines.md @@ -163,6 +163,8 @@ have permission to run CI/CD pipelines against the protected branch, the pipelin ### Passing variables to a downstream pipeline +#### With the `variables` keyword + Sometimes you might want to pass variables to a downstream pipeline. You can do that using the `variables` keyword, just like you would when defining a regular job. @@ -211,10 +213,49 @@ In this scenario, the `UPSTREAM_BRANCH` variable with a value related to the upstream pipeline will be passed to the `downstream-job` job, and will be available within the context of all downstream builds. -NOTE: **Tip:** Upstream pipelines take precedence over downstream ones. If there are two variables with the same name defined in both upstream and downstream projects, -the ones defined in the upstream project will take precedence. +the ones defined in the upstream project take precedence. + +#### With variable inheritance + +You can pass variables to a downstream pipeline with [`dotenv` variable inheritance](variables/README.md#inherit-environment-variables) and [cross project artifact downloads](yaml/README.md#cross-project-artifact-downloads-with-needs). + +In the upstream pipeline: + +1. Save the variables in a `.env` file. +1. Save the `.env` file as a `dotenv` report. +1. Trigger the downstream pipeline. + +```yaml +build_vars: + stage: build + script: + - echo "BUILD_VERSION=hello" >> build.env + artifacts: + reports: + dotenv: build.env + +deploy: + stage: deploy + trigger: my/downstream_project +``` + +Set the `test` job in the downstream pipeline to inherit the variables from the `build_vars` +job in the upstream project with `needs:`. The `test` job inherits the variables in the +`dotenv` report and it can access `BUILD_VERSION` in the script: + +```yaml +test: + stage: test + script: + - echo $BUILD_VERSION + needs: + - project: my/upstream_project + job: build_vars + ref: master + artifacts: true +``` ### Mirroring status from triggered pipeline @@ -280,3 +321,11 @@ Any pipelines that complete successfully for new tags in the subscribed project will now trigger a pipeline on the current project's default branch. The maximum number of upstream pipeline subscriptions is 2 by default, for both the upstream and downstream projects. This [application limit](../administration/instance_limits.md#number-of-cicd-subscriptions-to-a-project) can be changed on self-managed instances by a GitLab administrator. + +## Downstream private projects confidentiality concern + +If you trigger a pipeline in a downstream private project, the name of the project +and the status of the pipeline is visible in the upstream project's pipelines page. + +If you have a public project that can trigger downstream pipelines in a private +project, make sure to check that there are no confidentiality problems. diff --git a/doc/ci/parent_child_pipelines.md b/doc/ci/parent_child_pipelines.md index 83fa1d355e6..a0965643970 100644 --- a/doc/ci/parent_child_pipelines.md +++ b/doc/ci/parent_child_pipelines.md @@ -68,11 +68,22 @@ microservice_a: trigger: include: - local: path/to/microservice_a.yml - - template: SAST.gitlab-ci.yml + - template: Security/SAST.gitlab-ci.yml ``` -NOTE: **Note:** -The max number of entries that are accepted for `trigger:include:` is three. +In [GitLab 13.5](https://gitlab.com/gitlab-org/gitlab/-/issues/205157) and later, +you can use [`include:file`](yaml/README.md#includefile) to trigger child pipelines +with a configuration file in a different project: + +```yaml +microservice_a: + trigger: + include: + - project: 'my-group/my-pipeline-library' + file: 'path/to/ci-config.yml' +``` + +The maximum number of entries that are accepted for `trigger:include:` is three. Similar to [multi-project pipelines](multi_project_pipelines.md#mirroring-status-from-triggered-pipeline), we can set the parent pipeline to depend on the status of the child pipeline upon completion: @@ -82,7 +93,7 @@ microservice_a: trigger: include: - local: path/to/microservice_a.yml - - template: SAST.gitlab-ci.yml + - template: Security/SAST.gitlab-ci.yml strategy: depend ``` @@ -153,32 +164,13 @@ This is [resolved in GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/issues ## Nested child pipelines > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29651) in GitLab 13.4. -> - It's [deployed behind a feature flag](../user/feature_flags.md), enabled by default. -> - It's enabled on GitLab.com. -> - It's recommended for production use. -> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#enable-or-disable-nested-child-pipelines). **(CORE ONLY)** +> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/243747) in GitLab 13.5. Parent and child pipelines were introduced with a maximum depth of one level of child pipelines, which was later increased to two. A parent pipeline can trigger many child pipelines, and these child pipelines can trigger their own child pipelines. It's not possible to trigger another level of child pipelines. -### Enable or disable nested child pipelines **(CORE ONLY)** +## Pass variables to a child pipeline -Nested child pipelines with a depth of two are under development but ready for -production use. This feature is deployed behind a feature flag that is **enabled by default**. - -[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) -can opt to disable it. - -To enable it: - -```ruby -Feature.enable(:ci_child_of_child_pipeline) -``` - -To disable it: - -```ruby -Feature.disable(:ci_child_of_child_pipeline) -``` +You can [pass variables to a downstream pipeline](multi_project_pipelines.md#passing-variables-to-a-downstream-pipeline). diff --git a/doc/ci/pipelines/img/ci_efficiency_pipeline_dag_critical_path.png b/doc/ci/pipelines/img/ci_efficiency_pipeline_dag_critical_path.png Binary files differindex 1715e8224ab..421fddaf38d 100644 --- a/doc/ci/pipelines/img/ci_efficiency_pipeline_dag_critical_path.png +++ b/doc/ci/pipelines/img/ci_efficiency_pipeline_dag_critical_path.png diff --git a/doc/ci/pipelines/img/ci_efficiency_pipeline_health_grafana_dashboard.png b/doc/ci/pipelines/img/ci_efficiency_pipeline_health_grafana_dashboard.png Binary files differindex 0956e76804e..59276bda727 100644 --- a/doc/ci/pipelines/img/ci_efficiency_pipeline_health_grafana_dashboard.png +++ b/doc/ci/pipelines/img/ci_efficiency_pipeline_health_grafana_dashboard.png diff --git a/doc/ci/pipelines/index.md b/doc/ci/pipelines/index.md index 1b9048089bd..f7e3698b6d4 100644 --- a/doc/ci/pipelines/index.md +++ b/doc/ci/pipelines/index.md @@ -10,7 +10,7 @@ type: reference > Introduced in GitLab 8.8. -NOTE: **Tip:** +TIP: **Tip:** Watch the ["Mastering continuous software development"](https://about.gitlab.com/webcast/mastering-ci-cd/) webcast to see a comprehensive demo of a GitLab CI/CD pipeline. @@ -101,8 +101,8 @@ you can filter the pipeline list by: - Trigger author - Branch name -- Status ([since GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217617)) -- Tag ([since GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/217617)) +- Status ([GitLab 13.1 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/217617)) +- Tag ([GitLab 13.1 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/217617)) ### Run a pipeline manually @@ -114,7 +114,7 @@ operation of the pipeline. To execute a pipeline manually: 1. Navigate to your project's **CI/CD > Pipelines**. -1. Click on the **Run Pipeline** button. +1. Select the **Run Pipeline** button. 1. On the **Run Pipeline** page: 1. Select the branch to run the pipeline for in the **Create for** field. 1. Enter any [environment variables](../variables/README.md) required for the pipeline run. @@ -461,6 +461,28 @@ this line should be hidden when collapsed section_end:1560896353:my_first_section\r\e[0K ``` +#### Pre-collapse sections + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198413) in GitLab 13.5. + +You can make the job log automatically collapse collapsible sections by adding the `collapsed` option to the section start. +Add `[collapsed=true]` after the section name and before the `\r`. The section end marker +remains unchanged: + +- Section start marker with `[collapsed=true]`: `section_start:UNIX_TIMESTAMP:SECTION_NAME[collapsed=true]\r\e[0K` + `TEXT_OF_SECTION_HEADER` +- Section end marker: `section_end:UNIX_TIMESTAMP:SECTION_NAME\r\e[0K` + +Add the updated section start text to the CI configuration. For example, +using `echo`: + +```yaml +job1: + script: + - echo -e "section_start:`date +%s`:my_first_section[collapsed=true]\r\e[0KHeader of the 1st collapsible section" + - echo 'this line should be hidden automatically after loading the job log' + - echo -e "section_end:`date +%s`:my_first_section\r\e[0K" +``` + ## Visualize pipelines > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5742) in GitLab 8.11. @@ -473,7 +495,6 @@ and their statuses. Pipeline graphs can be displayed in two different ways, depending on the page you access the graph from. -NOTE: **Note:** GitLab capitalizes the stages' names in the pipeline graphs. ### Regular pipeline graphs diff --git a/doc/ci/pipelines/job_artifacts.md b/doc/ci/pipelines/job_artifacts.md index 750a76bfaa0..d904452a011 100644 --- a/doc/ci/pipelines/job_artifacts.md +++ b/doc/ci/pipelines/job_artifacts.md @@ -37,8 +37,8 @@ pdf: expire_in: 1 week ``` -A job named `pdf` calls the `xelatex` command in order to build a PDF file from -the latex source file `mycv.tex`. We then define the `artifacts` paths which in +A job named `pdf` calls the `xelatex` command to build a PDF file from the +latex source file `mycv.tex`. We then define the `artifacts` paths which in turn are defined with the `paths` keyword. All paths to files and directories are relative to the repository that was cloned during the build. @@ -61,12 +61,10 @@ The `artifacts:reports` keyword is used for collecting test reports, code qualit reports, and security reports from jobs. It also exposes these reports in GitLab's UI (merge requests, pipeline views, and security dashboards). -NOTE: **Note:** The test reports are collected regardless of the job results (success or failure). You can use [`artifacts:expire_in`](../yaml/README.md#artifactsexpire_in) to set up an expiration date for their artifacts. -NOTE: **Note:** If you also want the ability to browse the report output files, include the [`artifacts:paths`](../yaml/README.md#artifactspaths) keyword. @@ -96,7 +94,6 @@ rspec: The collected Unit test reports upload to GitLab as an artifact and display in merge requests. -NOTE: **Note:** If the JUnit tool you use exports to multiple XML files, specify multiple test report paths within a single job to concatenate them into a single file. Use a filename pattern (`junit: rspec-*.xml`), @@ -343,6 +340,11 @@ The latest artifacts are created by jobs in the **most recent** successful pipel for the specific ref. If you run two types of pipelines for the same ref, timing determines the latest artifact. For example, if a merge request creates a branch pipeline at the same time as a scheduled pipeline, the pipeline that completed most recently creates the latest artifact. +In [GitLab 13.5](https://gitlab.com/gitlab-org/gitlab/-/issues/201784) and later, artifacts +for [parent and child pipelines](../parent_child_pipelines.md) are searched in hierarchical +order from parent to child. For example, if both parent and child pipelines have a +job with the same name, the artifact from the parent pipeline is returned. + Artifacts for other pipelines can be accessed with direct access to them. The structure of the URL to download the whole artifacts archive is the following: @@ -429,7 +431,20 @@ To erase a job: ## Retrieve artifacts of private projects when using GitLab CI -In order to retrieve a job artifact of a different project, you might need to use a private token in order to [authenticate and download](../../api/job_artifacts.md#get-job-artifacts) the artifacts. +To retrieve a job artifact from a different project, you might need to use a +private token to [authenticate and download](../../api/job_artifacts.md#get-job-artifacts) +the artifact. + +## Troubleshooting + +### Error message `No files to upload` + +This is often preceded by other errors or warnings that specify the filename and why it wasn't +generated in the first place. Please check the entire job log for such messages. + +If you find no helpful messages, please retry the failed job after activating +[CI debug logging](../variables/README.md#debug-logging). +This provides useful information to investigate further. <!-- ## Troubleshooting diff --git a/doc/ci/pipelines/pipeline_artifacts.md b/doc/ci/pipelines/pipeline_artifacts.md new file mode 100644 index 00000000000..8d70fff4e03 --- /dev/null +++ b/doc/ci/pipelines/pipeline_artifacts.md @@ -0,0 +1,18 @@ +--- +stage: Verify +group: Continuous Integration +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +type: reference, howto +--- + +# Pipeline artifacts + +Pipeline artifacts are files created by GitLab after a pipeline finishes. These are different than [job artifacts](job_artifacts.md) because they are not explicitly managed by the `.gitlab-ci.yml` definitions. + +Pipeline artifacts are used by the [test coverage visualization feature](../../user/project/merge_requests/test_coverage_visualization.md) to collect coverage information. It uses the [`artifacts: reports`](../yaml/README.md#artifactsreports) CI/CD keyword. + +## Storage + +Pipeline artifacts are saved to disk or object storage. They count towards a project's [storage usage quota](../../user/group/index.md#storage-usage-quota). The **Artifacts** on the usage quote page is the sum of all job artifacts and pipeline artifacts. + +Pipeline artifacts are erased after one week. diff --git a/doc/ci/pipelines/schedules.md b/doc/ci/pipelines/schedules.md index e488179ffee..bcdb7c4c8b6 100644 --- a/doc/ci/pipelines/schedules.md +++ b/doc/ci/pipelines/schedules.md @@ -11,9 +11,6 @@ type: reference, howto > - Introduced in GitLab 9.1 as [Trigger Schedule](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10533). > - [Renamed to Pipeline Schedule](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10853) in GitLab 9.2. -NOTE: **Note:** -Cron notation is parsed by [Fugit](https://github.com/floraison/fugit). - Pipelines are normally run based on certain conditions being met. For example, when a branch is pushed to repository. Pipeline schedules can be used to also run [pipelines](index.md) at specific intervals. For example: @@ -24,6 +21,8 @@ Pipeline schedules can be used to also run [pipelines](index.md) at specific int In addition to using the GitLab UI, pipeline schedules can be maintained using the [Pipeline schedules API](../../api/pipeline_schedules.md). +Schedule timing is configured with cron notation, parsed by [Fugit](https://github.com/floraison/fugit). + ## Prerequisites In order for a scheduled pipeline to be created successfully: diff --git a/doc/ci/pipelines/settings.md b/doc/ci/pipelines/settings.md index 849eb66d07f..143a5346e88 100644 --- a/doc/ci/pipelines/settings.md +++ b/doc/ci/pipelines/settings.md @@ -36,13 +36,11 @@ in `.gitlab-ci.yml`. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/28919) in GitLab 12.0. -NOTE: **Note:** -As of GitLab 12.0, newly created projects will automatically have a default -`git depth` value of `50`. +It is possible to limit the number of changes that GitLab CI/CD fetches when cloning +a repository. Setting a limit to `git depth` can speed up Pipelines execution. -It is possible to limit the number of changes that GitLab CI/CD will fetch when cloning -a repository. Setting a limit to `git depth` can speed up Pipelines execution. Maximum -allowed value is `1000`. +In GitLab 12.0 and later, newly created projects automatically have a default +`git depth` value of `50`. The maximum allowed value is `1000`. To disable shallow clone and make GitLab CI/CD fetch all branches and tags each time, keep the value empty or set to `0`. @@ -75,7 +73,7 @@ For information about setting a maximum artifact size for a project, see > - [Support for external `.gitlab-ci.yml` locations](https://gitlab.com/gitlab-org/gitlab/-/issues/14376) introduced in GitLab 12.6. By default we look for the `.gitlab-ci.yml` file in the project's root -directory. If needed, you can specify an alternate path and file name, including locations outside the project. +directory. If needed, you can specify an alternate path and filename, including locations outside the project. To customize the path: @@ -93,12 +91,12 @@ paths and file names include: - `my/path/.gitlab-ci.yml` - `my/path/.my-custom-file.yml` -If the CI configuration will be hosted on an external site, the URL link must end with `.yml`: +If hosting the CI configuration on an external site, the URL link must end with `.yml`: - `http://example.com/generate/ci/config.yml` -If the CI configuration will be hosted in a different project within GitLab, the path must be relative -to the root directory in the other project, with the group and project name added to the end: +If hosting the CI configuration in a different project within GitLab, the path must be relative +to the root directory in the other project. Include the group and project name at the end: - `.gitlab-ci.yml@mygroup/another-project` - `my/path/.my-custom-file.yml@mygroup/another-project` @@ -109,7 +107,7 @@ configuration file. For example: - Create a public project to host the configuration file. - Give write permissions on the project only to users who are allowed to edit the file. -Other users and projects will be able to access the configuration file without being +Other users and projects can access the configuration file without being able to edit it. ## Test coverage parsing @@ -125,8 +123,8 @@ can use <https://rubular.com> to test your regex. The regex returns the **last** match found in the output. If the pipeline succeeds, the coverage is shown in the merge request widget and -in the jobs table. If multiple jobs in the pipeline have coverage reports, they will -be averaged. +in the jobs table. If multiple jobs in the pipeline have coverage reports, they are +averaged.  @@ -140,7 +138,7 @@ in the pipelines settings page. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/209121) the ability to download a `.csv` in GitLab 12.10. > - [Graph introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33743) in GitLab 13.1. -If you want to see the evolution of your project code coverage over time, +To see the evolution of your project code coverage over time, you can view a graph or download a CSV file with this data. From your project: 1. Go to **{chart}** **Project Analytics > Repository** to see the historic data for each job listed in the dropdown above the graph. @@ -150,13 +148,13 @@ you can view a graph or download a CSV file with this data. From your project: ### Removing color codes -Some test coverage tools output with ANSI color codes that won't be -parsed correctly by the regular expression and will cause coverage +Some test coverage tools output with ANSI color codes that aren't +parsed correctly by the regular expression. This causes coverage parsing to fail. -If your coverage tool doesn't provide an option to disable color -codes in the output, you can pipe the output of the coverage tool through a -small one line script that will strip the color codes off. +Some coverage tools don't provide an option to disable color +codes in the output. If so, pipe the output of the coverage tool through a +small one line script that strips the color codes off. For example: @@ -172,7 +170,7 @@ Pipeline visibility is determined by: - The **Public pipelines** project setting under your project's **Settings > CI/CD > General pipelines**. NOTE: **Note:** -If the project visibility is set to **Private**, the [**Public pipelines** setting will have no effect](../enable_or_disable_ci.md#per-project-user-setting). +If the project visibility is set to **Private**, the [**Public pipelines** setting has no effect](../enable_or_disable_ci.md#per-project-user-setting). This also determines the visibility of these related features: @@ -180,8 +178,7 @@ This also determines the visibility of these related features: - Job artifacts - The [pipeline security dashboard](../../user/application_security/security_dashboard/index.md#pipeline-security) **(ULTIMATE)** -NOTE: **Note:** -Currently, job logs and artifacts are [not yet visible for guest users and non-project members](https://gitlab.com/gitlab-org/gitlab/-/issues/25649). +Job logs and artifacts are [not visible for guest users and non-project members](https://gitlab.com/gitlab-org/gitlab/-/issues/25649). If **Public pipelines** is enabled (default): @@ -204,16 +201,14 @@ If **Public pipelines** is disabled: > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9362) in GitLab 9.1. -If you want all pending non-HEAD pipelines on branches to auto-cancel each time -a new pipeline is created, such as after a Git push or manually from the UI, -you can enable this in the project settings: +You can set pending or running pipelines to cancel automatically when a new pipeline runs on the same branch. You can enable this in the project settings: 1. Go to **Settings > CI / CD**. 1. Expand **General Pipelines**. 1. Check the **Auto-cancel redundant, pending pipelines** checkbox. 1. Click **Save changes**. -Note that only jobs with [interruptible](../yaml/README.md#interruptible) set to `true` will be cancelled. +Note that only jobs with [interruptible](../yaml/README.md#interruptible) set to `true` are cancelled. ## Skip outdated deployment jobs @@ -232,18 +227,18 @@ To avoid this scenario: 1. Check the **Skip outdated deployment jobs** checkbox. 1. Click **Save changes**. -The pending deployment jobs will be skipped. +When enabled, any older deployments job are skipped when a new deployment starts. For more information, see [Deployment safety](../environments/deployment_safety.md). ## Pipeline Badges In the pipelines settings page you can find pipeline status and test coverage -badges for your project. The latest successful pipeline will be used to read +badges for your project. The latest successful pipeline is used to read the pipeline status and test coverage values. Visit the pipelines settings page in your project to see the exact link to -your badges, as well as ways to embed the badge image in your HTML or Markdown +your badges. You can also see ways to embed the badge image in your HTML or Markdown pages.  @@ -276,8 +271,8 @@ https://gitlab.example.com/<namespace>/<project>/badges/<branch>/pipeline.svg?ig ### Test coverage report badge -GitLab makes it possible to define the regular expression for [coverage report](#test-coverage-parsing), -that each job log will be matched against. This means that each job in the +GitLab makes it possible to define the regular expression for the [coverage report](#test-coverage-parsing), +that each job log is matched against. This means that each job in the pipeline can have the test coverage percentage value defined. The test coverage badge can be accessed using following link: @@ -288,7 +283,7 @@ https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg If you would like to get the coverage report from a specific job, you can add the `job=coverage_job_name` parameter to the URL. For example, the following -Markdown code will embed the test coverage report badge of the `coverage` job +Markdown code embeds the test coverage report badge of the `coverage` job into your `README.md`: ```markdown @@ -297,7 +292,7 @@ into your `README.md`: ### Badge styles -Pipeline badges can be rendered in different styles by adding the `style=style_name` parameter to the URL. Currently two styles are available: +Pipeline badges can be rendered in different styles by adding the `style=style_name` parameter to the URL. Two styles are available: #### Flat (default) @@ -324,10 +319,10 @@ https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg?st 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/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=130 ``` - + ## Environment Variables diff --git a/doc/ci/quick_start/README.md b/doc/ci/quick_start/README.md index fa16614b0e0..246430a6458 100644 --- a/doc/ci/quick_start/README.md +++ b/doc/ci/quick_start/README.md @@ -68,11 +68,6 @@ blog about it](https://about.gitlab.com/blog/2015/05/06/why-were-replacing-gitla ### Creating a simple `.gitlab-ci.yml` file -NOTE: **Note:** -A GitLab team member has made an [unofficial visual pipeline editor](https://unofficial.gitlab.tools/visual-pipelines/). -There is a [plan to make it an official part of GitLab](https://gitlab.com/groups/gitlab-org/-/epics/4069) -in the future, but it's available for anyone who wants to try it at the above link. - You need to create a file named `.gitlab-ci.yml` in the root directory of your repository. This is a [YAML](https://en.wikipedia.org/wiki/YAML) file so you have to pay extra attention to indentation. Always use spaces, not tabs. @@ -117,9 +112,17 @@ What is important is that each job is run independently from each other. If you want to check whether the `.gitlab-ci.yml` of your project is valid, there is a [CI Lint tool](../lint.md) available in every project. +You can use the [CI/CD configuration visualization](../yaml/visualization.md) to +see a graphical representation of your `.gitlab-ci.yml`. + For more information and a complete `.gitlab-ci.yml` syntax, please read [the reference documentation on `.gitlab-ci.yml`](../yaml/README.md). +TIP: **Tip:** +A GitLab team member has made an [unofficial visual pipeline editor](https://unofficial.gitlab.tools/visual-pipelines/). +There is a [plan to make it an official part of GitLab](https://gitlab.com/groups/gitlab-org/-/epics/4069) +in the future, but it's available for anyone who wants to try it at the above link. + ### Push `.gitlab-ci.yml` to GitLab Once you've created `.gitlab-ci.yml`, you should add it to your Git repository diff --git a/doc/ci/review_apps/img/toolbar_feeback_form.png b/doc/ci/review_apps/img/toolbar_feeback_form.png Binary files differdeleted file mode 100644 index fe1c7e6e611..00000000000 --- a/doc/ci/review_apps/img/toolbar_feeback_form.png +++ /dev/null diff --git a/doc/ci/review_apps/img/toolbar_feedback_form_v13_5.png b/doc/ci/review_apps/img/toolbar_feedback_form_v13_5.png Binary files differnew file mode 100644 index 00000000000..dc4a13b2152 --- /dev/null +++ b/doc/ci/review_apps/img/toolbar_feedback_form_v13_5.png diff --git a/doc/ci/review_apps/index.md b/doc/ci/review_apps/index.md index e2d5cbcbea4..7110117709f 100644 --- a/doc/ci/review_apps/index.md +++ b/doc/ci/review_apps/index.md @@ -33,7 +33,7 @@ In the above example: ## How Review Apps work A Review App is a mapping of a branch with an [environment](../environments/index.md). -Access to the Review App is made available as a link on the [merge request](../../user/project/merge_requests.md) relevant to the branch. +Access to the Review App is made available as a link on the [merge request](../../user/project/merge_requests/index.md) relevant to the branch. The following is an example of a merge request with an environment set dynamically. @@ -188,20 +188,35 @@ Once you have the route mapping set up, it will take effect in the following loc ## Visual Reviews **(STARTER)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10761) in GitLab Starter 12.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10761) in GitLab Starter 12.0. +> - It's [deployed behind a feature flag](../../user/feature_flags.md), enabled by default. +> - It's enabled on GitLab.com. +> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#enable-or-disable-visual-reviews). **(STARTER ONLY)** -With Visual Reviews, you can provide a feedback form to your Review Apps so -that reviewers can post comments directly from the app back to the merge request -that spawned the Review App. +With Visual Reviews, members of any team (Product, Design, Quality, and so on) can provide feedback comments through a form in your review apps. The comments are added to the merge request that triggered the review app. -### Configuring Visual Reviews +### Using Visual Reviews -Ensure that the `anonymous_visual_review_feedback` feature flag is enabled. -Administrators can enable with a Rails console as follows: +After Visual Reviews has been [configured](#configure-review-apps-for-visual-reviews) for the +Review App, the Visual Reviews feedback form is overlaid on the right side of every page. -```ruby -Feature.enable(:anonymous_visual_review_feedback) -``` + + +To use the feedback form to make a comment in the merge request: + +1. Click the **Review** tab on the right side of a page. +1. Make a comment on the visual review. You can make use of all the + [Markdown annotations](../../user/markdown.md) that are also available in + merge request comments. +1. Enter your personal information: + - If [`data-require-auth`](#authentication-for-visual-reviews) is `true`, you must enter your [personal access token](../../user/profile/personal_access_tokens.md). + - Otherwise, enter your name, and optionally your email. +1. Click **Send feedback**. + +<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> +To see Visual reviews in action, see the [Visual Reviews Walk through](https://youtu.be/1_tvWTlPfM4). + +### Configure Review Apps for Visual Reviews The feedback form is served through a script you add to pages in your Review App. If you have [Developer permissions](../../user/permissions.md) to the project, @@ -212,18 +227,18 @@ if [route maps](#route-maps) are configured in the project.  The provided script should be added to the `<head>` of your application and -consists of some project and merge request specific values. Here's what it -looks like: +consists of some project and merge request specific values. Here's how it +looks for a project with code hosted in a project on GitLab.com: ```html <script data-project-id='11790219' data-merge-request-id='1' - data-mr-url='https://gitlab.example.com' + data-mr-url='https://gitlab.com' data-project-path='sarah/review-app-tester' data-require-auth='true' id='review-app-toolbar-script' - src='https://gitlab.example.com/assets/webpack/visual_review_toolbar.js'> + src='https://gitlab.com/assets/webpack/visual_review_toolbar.js'> </script> ``` @@ -239,21 +254,21 @@ to replace those values at runtime when each review app is created: - `data-mr-url` is the URL of the GitLab instance and will be the same for all review apps. - `data-project-path` is the project's path, which can be found by `CI_PROJECT_PATH`. -- `data-require-auth` is optional for public projects but required for [private and internal ones](#visual-reviews-in-private-or-internal-projects). If this is set to `true`, the user will be required to enter their [personal access token](../../user/profile/personal_access_tokens.md) instead of their name and email. +- `data-require-auth` is optional for public projects but required for [private and internal ones](#authentication-for-visual-reviews). If this is set to `true`, the user will be required to enter their [personal access token](../../user/profile/personal_access_tokens.md) instead of their name and email. - `id` is always `review-app-toolbar-script`, you don't need to change that. - `src` is the source of the review toolbar script, which resides in the respective GitLab instance and will be the same for all review apps. -For example, in a Ruby application, you would need to have this script: +For example, in a Ruby application with code hosted on in a project GitLab.com, you would need to have this script: ```html <script data-project-id="ENV['CI_PROJECT_ID']" data-merge-request-id="ENV['CI_MERGE_REQUEST_IID']" - data-mr-url='https://gitlab.example.com' + data-mr-url='https://gitlab.com' data-project-path="ENV['CI_PROJECT_PATH']" id='review-app-toolbar-script' - src='https://gitlab.example.com/assets/webpack/visual_review_toolbar.js'> + src='https://gitlab.com/assets/webpack/visual_review_toolbar.js'> </script> ``` @@ -273,33 +288,34 @@ can supply the ID by either:​​ - Dynamically adding the `data-merge-request-id` value during the build of the app. - Supplying it manually through the visual review form in the app. -### Visual Reviews in private or internal projects +### Enable or disable Visual Reviews **(STARTER ONLY)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/42750#note_317271120) in GitLab 12.10. +Visual Reviews is deployed behind a feature flag that is **enabled by default**. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can opt to disable it. -To enable visual reviews for private and internal projects, set the -[`data-require-auth` variable](#configuring-visual-reviews) to `true`. When enabled, -the user must enter a [personal access token](../../user/profile/personal_access_tokens.md) -with `api` scope before submitting feedback. +To disable it: -### Using Visual Reviews +```ruby +Feature.disable(:anonymous_visual_review_feedback) +``` -After Visual Reviews has been [enabled](#configuring-visual-reviews) for the -Review App, the Visual Reviews feedback form is overlaid on the app's pages at -the bottom-right corner. +To enable it: - +```ruby +Feature.enable(:anonymous_visual_review_feedback) +``` -To use the feedback form: +### Authentication for Visual Reviews -1. Make a comment on the visual review. You can make use of all the - [Markdown annotations](../../user/markdown.md) that are also available in - merge request comments. -1. If `data-require-auth` is `true`, you must enter your [personal access token](../../user/profile/personal_access_tokens.md). Otherwise, you must enter your name, and optionally, your email. -1. Finally, click **Send feedback**. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/42750#note_317271120) in GitLab 12.10. + +To enable visual reviews for private and internal projects, set the +[`data-require-auth` variable](#enable-or-disable-visual-reviews) to `true`. When enabled, +the user must enter a [personal access token](../../user/profile/personal_access_tokens.md) +with `api` scope before submitting feedback. -After you make and submit a comment in the visual review box, it will appear -automatically in the respective merge request. +This same method can be used to require authentication for any public projects. ## Limitations diff --git a/doc/ci/runners/README.md b/doc/ci/runners/README.md index 32561e6b98c..a3cc46f59bf 100644 --- a/doc/ci/runners/README.md +++ b/doc/ci/runners/README.md @@ -18,16 +18,12 @@ Runners can be specific to certain projects or available to all projects. ## Types of runners -There are three types of runners: +In the GitLab UI there are three types of runners, based on who you want to have access: -- [Shared](#shared-runners) (for all projects) -- [Group](#group-runners) (for all projects in a group) -- [Specific](#specific-runners) (for specific projects) - -If you are running self-managed GitLab, you can create your own runners. - -If you are using GitLab.com, you can use the shared runners provided by GitLab or -create your own group or specific runners. +- [Shared runners](#shared-runners) are available to all groups and projects in a GitLab instance. +- [Group runners](#group-runners) are available to all projects and subgroups in a group. +- [Specific runners](#specific-runners) are associated with specific projects. + Typically, specific runners are used for one project at a time. ### Shared runners @@ -39,11 +35,10 @@ multiple projects. If you are using a self-managed instance of GitLab: -- Your administrator can install and register shared runners by viewing the instructions - [here](https://docs.gitlab.com/runner/install/index.html). +- Your administrator can install and register shared runners by [following the documentation](https://docs.gitlab.com/runner/install/index.html). <!-- going to your project's <!-- **Settings > CI / CD**, expanding the **Runners** section, and clicking **Show runner installation instructions**.--> - <!-- These instructions are also available [here](https://docs.gitlab.com/runner/install/index.html).--> + <!-- These instructions are also available [in the documentation](https://docs.gitlab.com/runner/install/index.html).--> - The administrator can also configure a maximum number of shared runner [pipeline minutes for each group](../../user/admin_area/settings/continuous_integration.md#shared-runners-pipeline-minutes-quota). @@ -123,21 +118,20 @@ To enable shared runners: #### Disable shared runners -You can disable shared runners for individual projects<!-- or for groups-->. -You must have Owner permissions for the project<!-- or group-->. +You can disable shared runners for individual projects or for groups. +You must have Owner permissions for the project or group. To disable shared runners for a project: 1. Go to the project's **Settings > CI/CD** and expand the **Runners** section. 1. In the **Shared runners** area, click **Disable shared runners**. -<!--To disable shared runners for a group: +To disable shared runners for a group: 1. Go to the group's **Settings > CI/CD** and expand the **Runners** section. -1. In the **Shared runners** area, click **Disable shared runners globally**. +1. In the **Shared runners** area, click **Enable shared runners for this group**. 1. Optionally, to allow shared runners to be enabled for individual projects or subgroups, - click **Allow projects/subgroups to override the global setting**. ---> + click **Allow projects and subgroups to override the group setting**. ### Group runners diff --git a/doc/ci/secrets/index.md b/doc/ci/secrets/index.md index 6d561fe00a3..fb1183cd68b 100644 --- a/doc/ci/secrets/index.md +++ b/doc/ci/secrets/index.md @@ -17,23 +17,36 @@ Unlike CI variables, which are always presented to a job, secrets must be explic required by a job. Read [GitLab CI/CD pipeline configuration reference](../yaml/README.md#secrets) for more information about the syntax. -GitLab has selected [Vault by Hashicorp](https://www.vaultproject.io) as the +GitLab has selected [Vault by HashiCorp](https://www.vaultproject.io) as the first supported provider, and [KV-V2](https://www.vaultproject.io/docs/secrets/kv/kv-v2) as the first supported secrets engine. GitLab authenticates using Vault's -[JWT Auth method](https://www.vaultproject.io/docs/auth/jwt#jwt-authentication), using +[JSON Web Token (JWT) authentication method](https://www.vaultproject.io/docs/auth/jwt#jwt-authentication), using the [JSON Web Token](https://gitlab.com/gitlab-org/gitlab/-/issues/207125) (`CI_JOB_JWT`) introduced in GitLab 12.10. You must [configure your Vault server](#configure-your-vault-server) before you can use [use Vault secrets in a CI job](#use-vault-secrets-in-a-ci-job). +The flow for using GitLab with HashiCorp Vault +is summarized by this diagram: + + + +1. Configure your vault and secrets. +1. Generate your JWT and provide it to your CI job. +1. Runner contacts HashiCorp Vault and authenticates using the JWT. +1. HashiCorp Vault verifies the JWT. +1. HashiCorp Vault checks the bounded claims and attaches policies. +1. HashiCorp Vault returns the token. +1. Runner reads secrets from the HashiCorp Vault. + NOTE: **Note:** -Read the [Authenticating and Reading Secrets With Hashicorp Vault](../examples/authenticating-with-hashicorp-vault/index.md) -tutorial for a version of this feature that is available to all +Read the [Authenticating and Reading Secrets With HashiCorp Vault](../examples/authenticating-with-hashicorp-vault/index.md) +tutorial for a version of this feature. It's available to all subscription levels, supports writing secrets to and deleting secrets from Vault, -and multiple secrets engines. +and supports multiple secrets engines. ## Configure your Vault server @@ -90,7 +103,7 @@ the secrets stored in Vault by defining them with the `vault` keyword: ```yaml secrets: DATABASE_PASSWORD: - vault: production/db/password@ops # translates to secret `ops/data/production/db`, field `password` + vault: production/db/password@ops # translates to secret `ops/data/production/db`, field `password` ``` In this example: @@ -149,7 +162,7 @@ generated by this GitLab instance may be allowed to authenticate using this role For a full list of `CI_JOB_JWT` claims, read the [How it works](../examples/authenticating-with-hashicorp-vault/index.md#how-it-works) section of the -[Authenticating and Reading Secrets With Hashicorp Vault](../examples/authenticating-with-hashicorp-vault/index.md) tutorial. +[Authenticating and Reading Secrets With HashiCorp Vault](../examples/authenticating-with-hashicorp-vault/index.md) tutorial. You can also specify some attributes for the resulting Vault tokens, such as time-to-live, IP address range, and number of uses. The full list of options is available in diff --git a/doc/ci/services/postgres.md b/doc/ci/services/postgres.md index aadbce5a50a..96552ab1245 100644 --- a/doc/ci/services/postgres.md +++ b/doc/ci/services/postgres.md @@ -13,7 +13,7 @@ do this with the Docker and Shell executors of GitLab Runner. ## Use PostgreSQL with the Docker executor -If you are using [GitLab Runner](../runners/README.md) with the Docker executor +If you're using [GitLab Runner](../runners/README.md) with the Docker executor, you basically have everything set up already. First, in your `.gitlab-ci.yml` add: @@ -29,12 +29,11 @@ variables: POSTGRES_HOST_AUTH_METHOD: trust ``` -NOTE: **Note:** -The `POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD` and `POSTGRES_HOST_AUTH_METHOD` -variables can't be set in the GitLab UI. To set them, assign them to a variable -[in the UI](../variables/README.md#create-a-custom-variable-in-the-ui), and then assign that -variable to the `POSTGRES_DB`, `POSTGRES_USER`, `POSTGRES_PASSWORD` and `POSTGRES_HOST_AUTH_METHOD` -variables in your `.gitlab-ci.yml`. +To set values for the `POSTGRES_DB`, `POSTGRES_USER`, +`POSTGRES_PASSWORD` and `POSTGRES_HOST_AUTH_METHOD`, +[assign them to a variable in the user interface](../variables/README.md#create-a-custom-variable-in-the-ui), +then assign that variable to the corresponding variable in your +`.gitlab-ci.yml` file. And then configure your application to use the database, for example: @@ -45,14 +44,14 @@ Password: '' Database: nice_marmot ``` -If you are wondering why we used `postgres` for the `Host`, read more at +If you're wondering why we used `postgres` for the `Host`, read more at [How services are linked to the job](../docker/using_docker_images.md#how-services-are-linked-to-the-job). You can also use any other Docker image available on [Docker Hub](https://hub.docker.com/_/postgres). -For example, to use PostgreSQL 9.3 the service becomes `postgres:9.3`. +For example, to use PostgreSQL 9.3, the service becomes `postgres:9.3`. -The `postgres` image can accept some environment variables. For more details -check the documentation on [Docker Hub](https://hub.docker.com/_/postgres). +The `postgres` image can accept some environment variables. For more details, +see the documentation on [Docker Hub](https://hub.docker.com/_/postgres). ## Use PostgreSQL with the Shell executor @@ -65,7 +64,7 @@ First install the PostgreSQL server: sudo apt-get install -y postgresql postgresql-client libpq-dev ``` -The next step is to create a user, so login to PostgreSQL: +The next step is to create a user, so sign in to PostgreSQL: ```shell sudo -u postgres psql -d template1 @@ -74,24 +73,26 @@ sudo -u postgres psql -d template1 Then create a user (in our case `runner`) which will be used by your application. Change `$password` in the command below to a real strong password. -*__Note:__ Do not type `template1=#`, this is part of the PostgreSQL prompt.* +NOTE: **Note:** +Be sure to not enter `template1=#` in the following commands, as that's part of +the PostgreSQL prompt. ```shell template1=# CREATE USER runner WITH PASSWORD '$password' CREATEDB; ``` -*__Note:__ Notice that we created the user with the privilege to be able to -create databases (`CREATEDB`). In the following steps we will create a database -explicitly for that user but having that privilege can be useful if in your -testing framework you have tools that drop and create databases.* +The created user has the privilege to create databases (`CREATEDB`). The +following steps describe how to create a database explicitly for that user, but +having that privilege can be useful if in your testing framework you have tools +that drop and create databases. -Create the database and grant all privileges on it for the user `runner`: +Create the database and grant all privileges to it for the user `runner`: ```shell template1=# CREATE DATABASE nice_marmot OWNER runner; ``` -If all went well you can now quit the database session: +If all went well, you can now quit the database session: ```shell template1=# \q @@ -104,8 +105,8 @@ check that everything is in place. psql -U runner -h localhost -d nice_marmot -W ``` -*__Note:__ We are explicitly telling `psql` to connect to localhost in order -to use the md5 authentication. If you omit this step you will be denied access.* +This command explicitly directs `psql` to connect to localhost to use the md5 +authentication. If you omit this step, you'll be denied access. Finally, configure your application to use the database, for example: @@ -122,5 +123,5 @@ We have set up an [Example PostgreSQL Project](https://gitlab.com/gitlab-example convenience that runs on [GitLab.com](https://gitlab.com) using our publicly available [shared runners](../runners/README.md). -Want to hack on it? Simply fork it, commit and push your changes. Within a few +Want to hack on it? Fork it, commit, and push your changes. Within a few moments the changes will be picked by a public runner and the job will begin. diff --git a/doc/ci/ssh_keys/README.md b/doc/ci/ssh_keys/README.md index d8280316f19..12478000a0a 100644 --- a/doc/ci/ssh_keys/README.md +++ b/doc/ci/ssh_keys/README.md @@ -36,7 +36,6 @@ with any type of [executor](https://docs.gitlab.com/runner/executors/) `~/.ssh/authorized_keys`) or add it as a [deploy key](../../ssh/README.md#deploy-keys) if you are accessing a private GitLab repository. -NOTE: **Note:** The private key will not be displayed in the job log, unless you enable [debug logging](../variables/README.md#debug-logging). You might also want to check the [visibility of your pipelines](../pipelines/settings.md#visibility-of-pipelines). @@ -94,7 +93,6 @@ to access it. This is where an SSH key pair comes in handy. # - git config --global user.name "User name" ``` - NOTE: **Note:** The [`before_script`](../yaml/README.md#before_script-and-after_script) can be set globally or per-job. @@ -134,7 +132,8 @@ on, and use that key for all projects that are run on this machine. If you are accessing a private GitLab repository you need to add it as a [deploy key](../../ssh/README.md#deploy-keys). -Once done, try to log in to the remote server in order to accept the fingerprint: +After generating the key, try to sign in to the remote server to accept the +fingerprint: ```shell ssh example.com @@ -163,7 +162,6 @@ ssh-keyscan 1.2.3.4 Create a new [variable](../variables/README.md#gitlab-cicd-environment-variables) with `SSH_KNOWN_HOSTS` as "Key", and as a "Value" add the output of `ssh-keyscan`. -NOTE: **Note:** If you need to connect to multiple servers, all the server host keys need to be collected in the **Value** of the variable, one key per line. diff --git a/doc/ci/triggers/README.md b/doc/ci/triggers/README.md index 2b006b8779b..bcd19f0de6f 100644 --- a/doc/ci/triggers/README.md +++ b/doc/ci/triggers/README.md @@ -95,9 +95,9 @@ Read more about the [jobs API](../../api/job_artifacts.md#download-the-artifacts ## Adding a new trigger -You can add a new trigger by going to your project's -**Settings ➔ CI/CD** under **Triggers**. The **Add trigger** button will -create a new token which you can then use to trigger a rerun of this +Go to your +**Settings ➔ CI/CD** under **Triggers** to add a new trigger. The **Add trigger** button creates +a new token which you can then use to trigger a rerun of this particular project's pipeline. Every new trigger you create, gets assigned a different token which you can @@ -121,7 +121,7 @@ POST /projects/:id/trigger/pipeline ``` The required parameters are the [trigger's `token`](#authentication-tokens) -and the Git `ref` on which the trigger will be performed. Valid refs are +and the Git `ref` on which the trigger is performed. Valid refs are branches or tags. The `:id` of a project can be found by [querying the API](../../api/projects.md) or by visiting the **CI/CD** settings page which provides self-explanatory examples. @@ -146,7 +146,7 @@ curl --request POST \ https://gitlab.example.com/api/v4/projects/9/trigger/pipeline ``` -In this case, the project with ID `9` will get rebuilt on `master` branch. +In this case, the project with ID `9` gets rebuilt on `master` branch. Alternatively, you can pass the `token` and `ref` arguments in the query string: @@ -169,9 +169,9 @@ build_docs: - tags ``` -This means that whenever a new tag is pushed on project A, the job will run and the -`build_docs` job will be executed, triggering a rebuild of project B. The -`stage: deploy` ensures that this job will run only after all jobs with +This means that whenever a new tag is pushed on project A, the job runs and the +`build_docs` job is executed, triggering a rebuild of project B. The +`stage: deploy` ensures that this job runs only after all jobs with `stage: test` complete successfully. ## Triggering a pipeline from a webhook @@ -183,14 +183,14 @@ webhook URL for Push and Tag events (change the project ID, ref and token): https://gitlab.example.com/api/v4/projects/9/ref/master/trigger/pipeline?token=TOKEN ``` -`ref` should be passed as part of the URL in order to take precedence over -`ref` from the webhook body that designates the branch ref that fired the -trigger in the source repository. `ref` should be URL-encoded if it contains slashes. +You should pass `ref` as part of the URL, to take precedence over `ref` from +the webhook body that designates the branch ref that fired the trigger in the +source repository. Be sure to URL-encode `ref` if it contains slashes. ## Making use of trigger variables You can pass any number of arbitrary variables in the trigger API call and they -will be available in GitLab CI/CD so that they can be used in your `.gitlab-ci.yml` +are available in GitLab CI/CD so that they can be used in your `.gitlab-ci.yml` file. The parameter is of the form: ```plaintext @@ -237,7 +237,7 @@ upload_package: ``` You can then trigger a rebuild while you pass the `UPLOAD_TO_S3` variable -and the script of the `upload_package` job will run: +and the script of the `upload_package` job is run: ```shell curl --request POST \ @@ -252,10 +252,6 @@ of all types of variables. ## Using cron to trigger nightly pipelines -NOTE: **Note:** -The following behavior can also be achieved through GitLab's UI with -[pipeline schedules](../pipelines/schedules.md). - Whether you craft a script or just run cURL directly, you can trigger jobs in conjunction with cron. The example below triggers a job on the `master` branch of project with ID `9` every night at `00:30`: @@ -264,9 +260,12 @@ branch of project with ID `9` every night at `00:30`: 30 0 * * * curl --request POST --form token=TOKEN --form ref=master https://gitlab.example.com/api/v4/projects/9/trigger/pipeline ``` +This behavior can also be achieved through GitLab's UI with +[pipeline schedules](../pipelines/schedules.md). + ## Legacy triggers -Old triggers, created before GitLab 9.0 will be marked as legacy. +Old triggers, created before GitLab 9.0 are marked as legacy. Triggers with the legacy label do not have an associated user and only have access to the current project. They are considered deprecated and will be diff --git a/doc/ci/unit_test_reports.md b/doc/ci/unit_test_reports.md index 5a59a175a89..b9c1809bf0d 100644 --- a/doc/ci/unit_test_reports.md +++ b/doc/ci/unit_test_reports.md @@ -10,8 +10,6 @@ type: reference > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/45318) in GitLab 11.2. Requires GitLab Runner 11.2 and above. > - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39737) from JUnit test reports to Unit test reports in GitLab 13.4. -## Overview - It is very common that a [CI/CD pipeline](pipelines/index.md) contains a test job that will verify your code. If the tests fail, the pipeline fails and users get notified. The person that @@ -20,12 +18,12 @@ tests failed so that they can fix them. You can configure your job to use Unit test reports, and GitLab will display a report on the merge request so that it's easier and faster to identify the -failure without having to check the entire log. Unit test reports currently +failure without having to check the entire log. Unit test reports currently only support test reports in the JUnit report format. -If you don't use Merge Requests but still want to see the unit test report -output without searching through job logs, the full -[Unit test reports](#viewing-unit-test-reports-on-gitlab) are available +If you don't use Merge Requests but still want to see the unit test report +output without searching through job logs, the full +[Unit test reports](#viewing-unit-test-reports-on-gitlab) are available in the pipeline detail view. Consider the following workflow: @@ -84,7 +82,6 @@ To make the Unit test report output files browsable, include them with the To upload the report even if the job fails (for example if the tests do not pass), use the [`artifacts:when:always`](yaml/README.md#artifactswhen) keyword. -NOTE: **Note:** You cannot have multiple tests with the same name and class in your JUnit report format XML file. ### Ruby example @@ -146,8 +143,8 @@ java: junit: build/test-results/test/**/TEST-*.xml ``` -NOTE: **Note:** -Support for `**` was added in [GitLab Runner 13.0](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2620). +In [GitLab Runner 13.0](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2620) +and later, you can use `**`. #### Maven diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md index 1a982fa4e19..9c8fb994bf7 100644 --- a/doc/ci/variables/README.md +++ b/doc/ci/variables/README.md @@ -12,10 +12,11 @@ affect the way running processes behave on an operating system. Environment variables are part of the environment in which a process runs. -For example, a running process can query the value of the -`TEMP` environment variable to discover a suitable location -to store temporary files, or to define a `URL` for a database -that can be reused in different scripts. +For example, a running process could: + +- Use the value of a `TEMP` environment variable to know the correct location + to store temporary files. +- Use a `DATABASE_URL` variable for the URL to a database that can be reused in different scripts. Variables are useful for customizing your jobs in GitLab CI/CD. When you use variables, you don't have to hard-code values. @@ -62,22 +63,6 @@ job `test_variable`, which is `test`:  -As another example, let's say you're using your own GitLab -instance and you want to know what domain your GitLab Pages are -served under. You can call it by using the predefined -variable `$CI_PAGES_DOMAIN` in your script: - -```yaml -pages: - script: - - ... - - echo $CI_PAGES_DOMAIN -``` - -For GitLab.com users, the output is `gitlab.io`. For your -private instance, the output is whatever your sysadmin has -defined. - ## Custom environment variables When you need a specific custom environment variable, you can @@ -103,8 +88,8 @@ variables: You can then call its value in your script: ```yaml - script: - - echo "$TEST" +script: + - echo "$TEST" ``` For more details, see [`.gitlab-ci.yml` defined variables](#gitlab-ciyml-defined-variables). @@ -181,8 +166,8 @@ You can use tools like [the AWS CLI](https://docs.aws.amazon.com/cli/latest/user and [`kubectl`](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable) to customize your configuration by using **File** type variables. -In the past, a common pattern was to read the value of a CI variable, save it in a file, and then -use the newly created file in your script: +Previously, a common pattern was to read the value of a CI variable, save it in a file, and then +use that file in your script: ```shell # Read certificate stored in $KUBE_CA_PEM variable and save it in a new file @@ -258,7 +243,7 @@ Some variables are listed in the UI so you can choose them more quickly. | `AWS_DEFAULT_REGION` | Any | 12.10 | | `AWS_SECRET_ACCESS_KEY` | Any | 12.10 | -NOTE: **Note:** +CAUTION: **Caution:** When you store credentials, there are security implications. If you are using AWS keys, for example, follow their [best practices](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html). @@ -288,11 +273,11 @@ job_name: ### PowerShell -To access environment variables in a **Windows PowerShell** environment, prefix -the variable name with (`$env:`). For environment variables set by GitLab CI, including those set by [`variables`](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/ci/yaml/README.md#variables) -parameter, they can also be accessed by prefixing the variable name with (`$`) -as of [GitLab Runner 1.0.0](https://gitlab.com/gitlab-org/gitlab-runner/-/commit/abc44bb158008cd3a49c0d8173717c38dadb29ae#47afd7e8f12afdb8f0246262488f24e6dd071a22). -System set environment variables however must be accessed using (`$env:`). +To access variables in a **Windows PowerShell** environment, including system set +environment variables, prefix the variable name with (`$env:`). Environment variables +set by GitLab CI can also be accessed by prefixing the variable name with (`$`) with +[GitLab Runner 1.0.0](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/68) +and later. ```yaml job_name: @@ -386,9 +371,6 @@ export GITLAB_USER_ID="42" ## `.gitlab-ci.yml` defined variables -NOTE: **Note:** -This feature requires GitLab Runner 0.5.0 or higher and GitLab 7.14 or higher. - You can add variables that are set in the build environment to `.gitlab-ci.yml`. These variables are saved in the repository, and they are meant to store non-sensitive project configuration, like `RAILS_ENV` or @@ -428,10 +410,12 @@ script: > Introduced in GitLab 9.4. -You can define per-project or per-group variables -that are set in the pipeline environment. Group-level variables are stored out of -the repository (not in `.gitlab-ci.yml`) and are securely passed to GitLab Runner, -which makes them available during a pipeline run. For Premium users who do **not** use an external key store or who use GitLab's [integration with HashiCorp Vault](../secrets/index.md), we recommend using group environment variables to store secrets like passwords, SSH keys, and credentials. +You can define per-project or per-group variables that are set in the pipeline environment. Group-level variables are stored out of the repository (not in `.gitlab-ci.yml`). They are securely passed to GitLab Runner, which makes them available during a pipeline run. + +We recommend using group environment variables to store secrets (like passwords, SSH keys, and credentials) for Premium users who: + +- Do **not** use an external key store. +- Use GitLab's [integration with HashiCorp Vault](../secrets/index.md). Group-level variables can be added by: @@ -452,8 +436,7 @@ Once you set them, they are available for all subsequent pipelines. Any group-le Instance variables are useful for no longer needing to manually enter the same credentials repeatedly for all your projects. Instance-level variables are available to all projects and groups on the instance. -NOTE: **Note:** -The maximum number of instance-level variables is [planned to be 25](https://gitlab.com/gitlab-org/gitlab/-/issues/216097). +In GitLab 13.1 and later, the [maximum number of instance-level variables is 25](https://gitlab.com/gitlab-org/gitlab/-/issues/216097). You can define instance-level variables via the UI or [API](../../api/instance_level_ci_variables.md). @@ -463,7 +446,7 @@ To add an instance-level variable: 1. Click the **Add variable** button, and fill in the details: - **Key**: Must be one line, using only letters, numbers, or `_` (underscore), with no spaces. - - **Value**: [Since GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/220028), 10,000 characters allowed. This is also bounded by the limits of the selected runner operating system. In GitLab 13.0 to 13.2, 700 characters allowed. + - **Value**: [In GitLab 13.3 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/220028), 10,000 characters allowed. This is also bounded by the limits of the selected runner operating system. In GitLab 13.0 to 13.2, 700 characters allowed. - **Type**: `File` or `Variable`. - **Protect variable** (Optional): If selected, the variable is only available in pipelines that run on protected branches or tags. - **Mask variable** (Optional): If selected, the variable's **Value** is not shown in job logs. The variable is not saved if the value does not meet the [masking requirements](#masked-variable-requirements). @@ -566,12 +549,11 @@ variables take precedence over those defined in `.gitlab-ci.yml`. Variable names are limited by the underlying shell used to execute scripts (see [available shells](https://docs.gitlab.com/runner/shells/index.html). Each shell has its own unique set of reserved variable names. -You also want to keep in mind the [scope of environment variables](where_variables_can_be_used.md) to ensure a variable is defined in the scope -in which you wish to use it. +Keep in mind the [scope of environment variables](where_variables_can_be_used.md) to ensure a variable is defined in the scope in which you wish to use it. ## Where variables can be used -Click [here](where_variables_can_be_used.md) for a section that describes where and how the different types of variables can be used. +[This section](where_variables_can_be_used.md) describes where and how the different types of variables can be used. ## Advanced use @@ -609,8 +591,8 @@ then available as environment variables on the running application container. CAUTION: **Caution:** -Variables with multi-line values are not currently supported due to -limitations with the current Auto DevOps scripting environment. +Variables with multi-line values are not supported due to +limitations with the Auto DevOps scripting environment. ### Override a variable by manually running a pipeline @@ -701,9 +683,10 @@ Examples: - `$VARIABLE == ""` - `$VARIABLE != ""` (introduced in GitLab 11.11) -If you want to check whether a variable is defined, but is empty, you can -simply compare it against an empty string, like `$VAR == ''` or non-empty -string `$VARIABLE != ""`. +To check if a variable is defined but empty, compare it to: + +- An empty string: `$VARIABLE == ''` +- A non-empty string: `$VARIABLE != ""` #### Comparing two variables @@ -719,9 +702,8 @@ of these variables. Example: `$STAGING` -If you only want to create a job when there is some variable present, -which means that it is defined and non-empty, you can simply use -variable name as an expression, like `$STAGING`. If `$STAGING` variable +To create a job when there is some variable present, meaning it is defined and non-empty, +use the variable name as an expression, like `$STAGING`. If the `$STAGING` variable is defined, and is non empty, expression evaluates to `true`. `$STAGING` value needs to be a string, with length higher than zero. Variable that contains only whitespace characters is not an empty variable. @@ -785,7 +767,7 @@ Examples: ##### Enable or disable parenthesis support for variables **(CORE ONLY)** -The feature is currently deployed behind a feature flag that is **enabled by default**. +The feature is deployed behind a feature flag that is **enabled by default**. [GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) can opt to disable it for your instance. @@ -820,8 +802,7 @@ NOTE: **Note:** The available regular expression syntax is limited. See [related issue](https://gitlab.com/gitlab-org/gitlab/-/issues/35438) for more details. -If needed, you can use a test pipeline to determine whether a regular expression will -work in a variable. The example below tests the `^mast.*` regular expression directly, +If needed, you can use a test pipeline to determine whether a regular expression works in a variable. The example below tests the `^mast.*` regular expression directly, as well as from within a variable: ```yaml @@ -856,9 +837,7 @@ from being leaked into the log unless your script writes them to the screen. If a job isn't working as expected, this can make the problem difficult to investigate; in these cases, you can enable debug tracing in `.gitlab-ci.yml`. -Available on GitLab Runner v1.7+, this feature enables the shell's execution -log, resulting in a verbose job log listing all commands that were run, -variables that were set, and so on. +Available on GitLab Runner v1.7+, this feature enables the shell's execution log. This results in a verbose job log listing all commands that were run, variables that were set, and so on. Before enabling this, you should ensure jobs are visible to [team members only](../../user/permissions.md#project-features). You should diff --git a/doc/ci/variables/deprecated_variables.md b/doc/ci/variables/deprecated_variables.md index 94ec8439605..71e2b5b2e44 100644 --- a/doc/ci/variables/deprecated_variables.md +++ b/doc/ci/variables/deprecated_variables.md @@ -16,7 +16,6 @@ To follow conventions of naming across GitLab, and to further move away from the `build` term and toward `job`, some [CI/CD environment variables](README.md#predefined-environment-variables) were renamed for GitLab 9.0 release. -NOTE: **Note:** Starting with GitLab 9.0, we have deprecated the `$CI_BUILD_*` variables. **You are strongly advised to use the new variables as we will remove the old ones in future GitLab releases.** diff --git a/doc/ci/variables/predefined_variables.md b/doc/ci/variables/predefined_variables.md index 915041b71a6..08aaacd2620 100644 --- a/doc/ci/variables/predefined_variables.md +++ b/doc/ci/variables/predefined_variables.md @@ -69,7 +69,8 @@ Kubernetes-specific environment variables are detailed in the | `CI_JOB_MANUAL` | 8.12 | all | The flag to indicate that job was manually started | | `CI_JOB_NAME` | 9.0 | 0.5 | The name of the job as defined in `.gitlab-ci.yml` | | `CI_JOB_STAGE` | 9.0 | 0.5 | The name of the stage as defined in `.gitlab-ci.yml` | -| `CI_JOB_TOKEN` | 9.0 | 1.2 | Token used for authenticating with the [GitLab Container Registry](../../user/packages/container_registry/index.md), downloading [dependent repositories](../../user/project/new_ci_build_permissions_model.md#dependent-repositories), and accessing [GitLab-managed Terraform state](../../user/infrastructure/index.md#gitlab-managed-terraform-state). | +| `CI_JOB_STATUS` | all | 13.5 | The state of the job as each runner stage is executed. Use with [`after_script`](../yaml/README.md#before_script-and-after_script) where `CI_JOB_STATUS` can be either: `success`, `failed` or `canceled`. | +| `CI_JOB_TOKEN` | 9.0 | 1.2 | Token used for authenticating with [a few API endpoints](../../api/README.md#gitlab-ci-job-token) and downloading [dependent repositories](../../user/project/new_ci_build_permissions_model.md#dependent-repositories). The token is valid as long as the job is running. | | `CI_JOB_JWT` | 12.10 | all | RS256 JSON web token that can be used for authenticating with third party systems that support JWT authentication, for example [HashiCorp's Vault](../secrets/index.md). | | `CI_JOB_URL` | 11.1 | 0.5 | Job details URL | | `CI_KUBERNETES_ACTIVE` | 13.0 | all | Included with the value `true` only if the pipeline has a Kubernetes cluster available for deployments. Not included if no cluster is available. Can be used as an alternative to [`only:kubernetes`/`except:kubernetes`](../yaml/README.md#onlykubernetesexceptkubernetes) with [`rules:if`](../yaml/README.md#rulesif) | @@ -104,7 +105,7 @@ Kubernetes-specific environment variables are detailed in the | `CI_PROJECT_ID` | all | all | The unique ID of the current project that GitLab CI/CD uses internally | | `CI_PROJECT_NAME` | 8.10 | 0.5 | The name of the directory for the project that is currently being built. For example, if the project URL is `gitlab.example.com/group-name/project-1`, the `CI_PROJECT_NAME` would be `project-1`. | | `CI_PROJECT_NAMESPACE` | 8.10 | 0.5 | The project namespace (username or group name) that is currently being built | -| `CI_PROJECT_ROOT_NAMESPACE` | 13.2 | 0.5 | The **root** project namespace (username or group name) that is currently being built. For example, if `CI_PROJECT_NAME` is `root-group/child-group/grandchild-group`, `CI_PROJECT_ROOT_NAMESPACE` would be `root-group`. | +| `CI_PROJECT_ROOT_NAMESPACE` | 13.2 | 0.5 | The **root** project namespace (username or group name) that is currently being built. For example, if `CI_PROJECT_NAMESPACE` is `root-group/child-group/grandchild-group`, `CI_PROJECT_ROOT_NAMESPACE` would be `root-group`. | | `CI_PROJECT_PATH` | 8.10 | 0.5 | The namespace with project name | | `CI_PROJECT_PATH_SLUG` | 9.3 | all | `$CI_PROJECT_PATH` lowercased and with everything except `0-9` and `a-z` replaced with `-`. Use in URLs and domain names. | | `CI_PROJECT_REPOSITORY_LANGUAGES` | 12.3 | all | Comma-separated, lowercased list of the languages used in the repository (e.g. `ruby,javascript,html,css`) | diff --git a/doc/ci/variables/where_variables_can_be_used.md b/doc/ci/variables/where_variables_can_be_used.md index 330b960ca9a..b4236ca34c2 100644 --- a/doc/ci/variables/where_variables_can_be_used.md +++ b/doc/ci/variables/where_variables_can_be_used.md @@ -38,15 +38,14 @@ There are two places defined variables can be used. On the: ### `config.toml` file -NOTE: **Note:** -You can read more about `config.toml` in the [GitLab Runner docs](https://docs.gitlab.com/runner/configuration/advanced-configuration.html). - | Definition | Can be expanded? | Description | |:-------------------------------------|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------| | `runners.environment` | yes | The variable expansion is made by GitLab Runner's [internal variable expansion mechanism](#gitlab-runner-internal-variable-expansion-mechanism) | | `runners.kubernetes.pod_labels` | yes | The Variable expansion is made by GitLab Runner's [internal variable expansion mechanism](#gitlab-runner-internal-variable-expansion-mechanism) | | `runners.kubernetes.pod_annotations` | yes | The Variable expansion is made by GitLab Runner's [internal variable expansion mechanism](#gitlab-runner-internal-variable-expansion-mechanism) | +You can read more about `config.toml` in the [GitLab Runner docs](https://docs.gitlab.com/runner/configuration/advanced-configuration.html). + ## Expansion mechanisms There are three expansion mechanisms: @@ -104,10 +103,6 @@ These restrictions are because `after_script` scripts are executed in a ## Persisted variables -NOTE: **Note:** -Some of the persisted variables contain tokens and cannot be used by some definitions -due to security reasons. - The following variables are known as "persisted": - `CI_PIPELINE_ID` @@ -130,6 +125,9 @@ They are: - For definitions where the ["Expansion place"](#gitlab-ciyml-file) is GitLab. - In the `only` and `except` [variables expressions](README.md#environment-variables-expressions). +Some of the persisted variables contain tokens and cannot be used by some definitions +due to security reasons. + ## Variables with an environment scope Variables defined with an environment scope are supported. Given that diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 40df9c7c986..2e4ab68a0e8 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -33,11 +33,8 @@ We have complete examples of configuring pipelines: > - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> Learn how [Verizon reduced rebuilds](https://about.gitlab.com/blog/2019/02/14/verizon-customer-story/) > from 30 days to under 8 hours with GitLab. -NOTE: **Note:** If you have a [mirrored repository that GitLab pulls from](../../user/project/repository/repository_mirroring.md#pulling-from-a-remote-repository), -you may need to enable pipeline triggering. Go to your project's - -**Settings > Repository > Pull from a remote repository > Trigger pipelines for mirror updates**. +you may need to enable pipeline triggering. Go to your project's **Settings > Repository > Pull from a remote repository > Trigger pipelines for mirror updates**. ## Introduction @@ -107,12 +104,12 @@ The following table lists available parameters for jobs: | [`script`](#script) | Shell script that is executed by a runner. | | [`after_script`](#before_script-and-after_script) | Override a set of commands that are executed after job. | | [`allow_failure`](#allow_failure) | Allow job to fail. Failed job does not contribute to commit status. | -| [`artifacts`](#artifacts) | List of files and directories to attach to a job on success. Also available: `artifacts:paths`, `artifacts:exclude`, `artifacts:expose_as`, `artifacts:name`, `artifacts:untracked`, `artifacts:when`, `artifacts:expire_in`, `artifacts:reports`. | +| [`artifacts`](#artifacts) | List of files and directories to attach to a job on success. Also available: `artifacts:paths`, `artifacts:exclude`, `artifacts:expose_as`, `artifacts:name`, `artifacts:untracked`, `artifacts:when`, `artifacts:expire_in`, and `artifacts:reports`. | | [`before_script`](#before_script-and-after_script) | Override a set of commands that are executed before job. | -| [`cache`](#cache) | List of files that should be cached between subsequent runs. Also available: `cache:paths`, `cache:key`, `cache:untracked`, and `cache:policy`. | +| [`cache`](#cache) | List of files that should be cached between subsequent runs. Also available: `cache:paths`, `cache:key`, `cache:untracked`, `cache:when`, and `cache:policy`. | | [`coverage`](#coverage) | Code coverage settings for a given job. | | [`dependencies`](#dependencies) | Restrict which artifacts are passed to a specific job by providing a list of jobs to fetch artifacts from. | -| [`environment`](#environment) | Name of an environment to which the job deploys. Also available: `environment:name`, `environment:url`, `environment:on_stop`, `environment:auto_stop_in` and `environment:action`. | +| [`environment`](#environment) | Name of an environment to which the job deploys. Also available: `environment:name`, `environment:url`, `environment:on_stop`, `environment:auto_stop_in`, and `environment:action`. | | [`except`](#onlyexcept-basic) | Limit when jobs are not created. Also available: [`except:refs`, `except:kubernetes`, `except:variables`, and `except:changes`](#onlyexcept-advanced). | | [`extends`](#extends) | Configuration entries that this job inherits from. | | [`image`](#image) | Use Docker images. Also available: `image:name` and `image:entrypoint`. | @@ -184,7 +181,7 @@ To enable or disable the inheritance of all `variables:` or `default:` parameter - `variables: true` or `variables: false` To inherit only a subset of `default:` parameters or `variables:`, specify what -you wish to inherit, and any not listed will **not** be inherited. Use +you wish to inherit. Anything not listed is **not** inherited. Use one of the following formats: ```yaml @@ -208,16 +205,16 @@ inherit: In the example below: - `rubocop`: - - **will** inherit: Nothing. + - inherits: Nothing. - `rspec`: - - **will** inherit: the default `image` and the `WEBHOOK_URL` variable. - - will **not** inherit: the default `before_script` and the `DOMAIN` variable. + - inherits: the default `image` and the `WEBHOOK_URL` variable. + - does **not** inherit: the default `before_script` and the `DOMAIN` variable. - `capybara`: - - **will** inherit: the default `before_script` and `image`. - - will **not** inherit: the `DOMAIN` and `WEBHOOK_URL` variables. + - inherits: the default `before_script` and `image`. + - does **not** inherit: the `DOMAIN` and `WEBHOOK_URL` variables. - `karma`: - - **will** inherit: the default `image` and `before_script`, and the `DOMAIN` variable. - - will **not** inherit: `WEBHOOK_URL` variable. + - inherits: the default `image` and `before_script`, and the `DOMAIN` variable. + - does **not** inherit: `WEBHOOK_URL` variable. ```yaml default: @@ -347,23 +344,23 @@ workflow: This example never allows pipelines for schedules or `push` (branches and tags) pipelines, but does allow pipelines in **all** other cases, *including* merge request pipelines. -As with `rules` defined in jobs, be careful not to use a configuration that allows -merge request pipelines and branch pipelines to run at the same time, or you could -have [duplicate pipelines](#prevent-duplicate-pipelines). +Be careful not to use a configuration that might run +merge request pipelines and branch pipelines at the same time. As with `rules` defined in jobs, +it can cause [duplicate pipelines](#prevent-duplicate-pipelines). #### `workflow:rules` templates > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217732) in GitLab 13.0. -We provide pre-made templates for use with your pipelines that set up `workflow: rules` -for common scenarios. Usage of these will make things easier and prevent duplicate pipelines from running. +We provide templates that set up `workflow: rules` +for common scenarios. These templates help prevent duplicate pipelines. The [`Branch-Pipelines` template](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/ci/templates/Workflows/Branch-Pipelines.gitlab-ci.yml) makes your pipelines run for branches and tags. -Branch pipeline status will be displayed within merge requests that use that branch -as a source, but this pipeline type does not support any features offered by -[Merge Request Pipelines](../merge_request_pipelines/) like +Branch pipeline status is displayed within merge requests that use the branch +as a source. However, this pipeline type does not support any features offered by +[Merge Request Pipelines](../merge_request_pipelines/), like [Pipelines for Merge Results](../merge_request_pipelines/#pipelines-for-merged-results) or [Merge Trains](../merge_request_pipelines/pipelines_for_merged_results/merge_trains/). Use this template if you are intentionally avoiding those features. @@ -391,7 +388,7 @@ include: ### `include` > - Introduced in [GitLab Premium](https://about.gitlab.com/pricing/) 10.5. -> - Available for Starter, Premium and Ultimate since 10.6. +> - Available for Starter, Premium, and Ultimate in GitLab 10.6 and later. > - [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/42861) to GitLab Core in 11.4. Using the `include` keyword allows the inclusion of external YAML files. This helps @@ -402,6 +399,10 @@ configuration files. This helps avoid duplicated configuration, for example, glo `include` requires the external YAML file to have the extensions `.yml` or `.yaml`, otherwise the external file is not included. +Using [YAML anchors](#anchors) across different YAML files sourced by `include` is not +supported. You must only refer to anchors in the same file. Instead +of using YAML anchors, you can use the [`extends` keyword](#extends). + `include` supports the following inclusion methods: | Method | Description | @@ -413,7 +414,6 @@ otherwise the external file is not included. The `include` methods do not support [variable expansion](../variables/where_variables_can_be_used.md#variables-usage). -NOTE: **Note:** `.gitlab-ci.yml` configuration included by all methods is evaluated at pipeline creation. The configuration is a snapshot in time and persisted in the database. Any changes to referenced `.gitlab-ci.yml` configuration is not reflected in GitLab until the next pipeline is created. @@ -428,11 +428,6 @@ TIP: **Tip:** Use merging to customize and override included CI/CD configurations with local definitions. Local definitions in `.gitlab-ci.yml` override included definitions. -NOTE: **Note:** -Using [YAML anchors](#anchors) across different YAML files sourced by `include` is not -supported. You must only refer to anchors in the same file. Instead -of using YAML anchors, you can use the [`extends` keyword](#extends). - #### `include:local` `include:local` includes a file from the same repository as `.gitlab-ci.yml`. @@ -442,12 +437,11 @@ You can only use files that are tracked by Git on the same branch your configuration file is on. In other words, when using a `include:local`, make sure that both `.gitlab-ci.yml` and the local file are on the same branch. +Including local files through Git submodules paths is not supported. + All [nested includes](#nested-includes) are executed in the scope of the same project, so it's possible to use local, project, remote, or template includes. -NOTE: **Note:** -Including local files through Git submodules paths is not supported. - Example: ```yaml @@ -455,7 +449,6 @@ include: - local: '/templates/.gitlab-ci-template.yml' ``` -TIP: **Tip:** Local includes can be used as a replacement for symbolic links that are not followed. This can be defined as a short local include: @@ -495,8 +488,8 @@ include: file: '/templates/.gitlab-ci-template.yml' ``` -All [nested includes](#nested-includes) are executed in the scope of the target project, -so it's possible to use local (relative to target project), project, remote +All [nested includes](#nested-includes) are executed in the scope of the target project. +This means you can use local (relative to target project), project, remote, or template includes. #### `include:remote` @@ -548,7 +541,7 @@ Nested includes allow you to compose a set of includes. A total of 100 includes is allowed, but duplicate includes are considered a configuration error. -Since [GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/issues/28212), the time limit +In [GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/issues/28212) and later, the time limit for resolving all files is 30 seconds. #### Additional `includes` examples @@ -635,10 +628,9 @@ job: - bundle exec rspec ``` -NOTE: **Note:** Sometimes, `script` commands must be wrapped in single or double quotes. -For example, commands that contain a colon (`:`) must be wrapped in quotes so -that the YAML parser knows to interpret the whole thing as a string rather than +For example, commands that contain a colon (`:`) must be wrapped in quotes. +The YAML parser needs to interpret the text as a string rather than a "key: value" pair. Be careful when using special characters: `:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `` ` ``. @@ -657,15 +649,18 @@ job: > Introduced in GitLab 8.7 and requires GitLab Runner v1.2. -`before_script` is used to define a command that should be run before each +`before_script` is used to define commands that should be run before each job, including deploy jobs, but after the restoration of any [artifacts](#artifacts). This must be an array. Scripts specified in `before_script` are concatenated with any scripts specified in the main [`script`](#script), and executed together in a single shell. -`after_script` is used to define the command that runs after each -job, including failed ones. This must be an array. +`after_script` is used to define commands that run after each +job, including failed jobs. This must be an array. If a job times out or is cancelled, +the `after_script` commands are not executed. Support for executing `after_script` +commands for timed-out or cancelled jobs +[is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/15603). Scripts specified in `after_script` are executed in a new shell, separate from any `before_script` or `script` scripts. As a result, they: @@ -744,11 +739,11 @@ using [`|` (literal) and `>` (folded) YAML multi-line block scalar indicators](h CAUTION: **Warning:** If multiple commands are combined into one command string, only the last command's -failure or success is reported, -[incorrectly ignoring failures from earlier commands due to a bug](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/25394). -If the success of the job depends on the success or failure of these commands, -you can run the commands as separate `script:` items, or add `exit 1` commands -as appropriate to the command string where needed. +failure or success is reported. +[Failures from earlier commands are ignored due to a bug](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/25394). +To work around this, +run each command as a separate `script:` item, or add an `exit 1` command +to each command string. You can use the `|` (literal) YAML multiline block scalar indicator to write commands over multiple lines in the `script` section of a job description. @@ -808,7 +803,7 @@ Second command line. ``` When you omit the `>` or `|` block scalar indicators, GitLab forms the command -by concatenating non-empty lines, so make sure the lines can run when concatenated. +by concatenating non-empty lines. Make sure the lines can run when concatenated. Shell [here documents](https://en.wikipedia.org/wiki/Here_document) work with the `|` and `>` operators as well. The example below transliterates the lower case letters @@ -895,6 +890,8 @@ The following stages are available to every pipeline: User-defined stages are executed after `.pre` and before `.post`. +A pipeline is not created if all jobs are in `.pre` or `.post` stages. + The order of `.pre` and `.post` can't be changed, even if defined out of order in `.gitlab-ci.yml`. For example, the following are equivalent configuration: @@ -926,9 +923,6 @@ For example, the following are equivalent configuration: - b ``` -NOTE: **Note:** -A pipeline is not created if all jobs are in `.pre` or `.post` stages. - ### `extends` > Introduced in GitLab 11.3. @@ -961,7 +955,7 @@ GitLab performs a reverse deep merge based on the keys. GitLab: - Merges the `rspec` contents into `.tests` recursively. - Doesn't merge the values of the keys. -The result is this `rspec` job: +The result is this `rspec` job, where `script: rake test` is overwritten by `script: rake rspec`: ```yaml rspec: @@ -974,9 +968,6 @@ rspec: - $RSPEC ``` -NOTE: **Note:** -Note that `script: rake test` has been overwritten by `script: rake rspec`. - If you do want to include the `rake test`, see [`before_script` and `after_script`](#before_script-and-after_script). `.tests` in this example is a [hidden job](#hide-jobs), but it's @@ -1113,7 +1104,6 @@ is either included or excluded from the pipeline, depending on the configuration If included, the job also has [certain attributes](#rules-attributes) added to it. -CAUTION: **Caution:** `rules` replaces [`only/except`](#onlyexcept-basic) and can't be used in conjunction with it. If you attempt to use both keywords in the same job, the linter returns a `key may not be used with rules` error. @@ -1500,9 +1490,8 @@ job: - spec/**.rb ``` -NOTE: **Note:** -For performance reasons, using `exists` with patterns is limited to 10000 -checks. After the 10000th check, rules with patterned globs always match. +For performance reasons, using `exists` with patterns is limited to 10,000 +checks. After the 10,000th check, rules with patterned globs always match. #### `rules:allow_failure` @@ -1543,15 +1532,15 @@ docker build: script: docker build -t my-image:$CI_COMMIT_REF_SLUG . rules: - if: '$VAR == "string value"' - changes: # Will include the job and set to when:manual if any of the follow paths match a modified file. + changes: # Include the job and set to when:manual if any of the follow paths match a modified file. - Dockerfile - docker/scripts/* when: manual - # - when: never would be redundant here, this is implied any time rules are listed. + # - when: never would be redundant here, this is implied any time rules are listed. ``` -Keywords such as `branches` or `refs` that are currently available for -`only`/`except` are not yet available in `rules` as they are being individually +Keywords such as `branches` or `refs` that are available for +`only`/`except` are not available in `rules`. They are being individually considered for their usage and behavior in this context. Future keyword improvements are being discussed in our [epic for improving `rules`](https://gitlab.com/groups/gitlab-org/-/epics/2783), where anyone can add suggestions or requests. @@ -1567,10 +1556,9 @@ job1: if: ($CI_COMMIT_BRANCH == "master" || $CI_COMMIT_BRANCH == "develop") && $MY_VARIABLE ``` -NOTE: **Note:** -In GitLab 13.2 and older, the order of operations when mixing `||` and `&&` in a single rule may not have executed -in the expected order. This is [fixed](https://gitlab.com/gitlab-org/gitlab/-/issues/230938) -in GitLab 13.3. +CAUTION: **Caution:** +[Before GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/230938), +rules that use both `||` and `&&` may evaluate with an unexpected order of operations. ### `only`/`except` (basic) @@ -1611,8 +1599,8 @@ In addition, `only` and `except` allow the use of special keywords: | `triggers` | For pipelines created by using a [trigger token](../triggers/README.md#trigger-token). | | `web` | For pipelines created by using **Run pipeline** button in the GitLab UI, from the project's **CI/CD > Pipelines** section. | -In the example below, `job` will run only for refs that start with `issue-`, -whereas all branches will be skipped: +In the example below, `job` runs only for refs that start with `issue-`, +whereas all branches are skipped: ```yaml job: @@ -1637,8 +1625,8 @@ job: - branches ``` -In this example, `job` will run only for refs that are tagged, or if a build is -explicitly requested via an API trigger or a [Pipeline Schedule](../pipelines/schedules.md): +In this example, `job` runs only for refs that are tagged, or if a build is +explicitly requested by an API trigger or a [Pipeline Schedule](../pipelines/schedules.md): ```yaml job: @@ -1684,19 +1672,19 @@ job: #### Regular expressions -Because `@` is used to denote the beginning of a ref's repository path, -matching a ref name containing the `@` character in a regular expression -requires the use of the hex character code match `\x40`. +The `@` symbol denotes the beginning of a ref's repository path. +To match a ref name that contains the `@` character in a regular expression, +you must use the hex character code match `\x40`. Only the tag or branch name can be matched by a regular expression. The repository path, if given, is always matched literally. -If a regular expression shall be used to match the tag or branch name, -the entire ref name part of the pattern has to be a regular expression, -and must be surrounded by `/`. -(With regular expression flags appended after the closing `/`.) -So `issue-/.*/` won't work to match all tag names or branch names -that begin with `issue-`. +To match the tag or branch name, +the entire ref name part of the pattern must be a regular expression surrounded by `/`. +For example, you can't use `issue-/.*/` to match all tag names or branch names +that begin with `issue-`, but you can use `/issue-.*/`. + +Regular expression flags must be appended after the closing `/`. TIP: **Tip:** Use anchors `^` and `$` to avoid the regular expression @@ -1706,20 +1694,17 @@ while just `/issue/` would also match a branch called `severe-issues`. #### Supported `only`/`except` regexp syntax -CAUTION: **Warning:** -This is a breaking change that was introduced with GitLab 11.9.4. - -In GitLab 11.9.4, GitLab begun internally converting regexp used +In GitLab 11.9.4, GitLab began internally converting the regexp used in `only` and `except` parameters to [RE2](https://github.com/google/re2/wiki/Syntax). -This means that only subset of features provided by [Ruby Regexp](https://ruby-doc.org/core/Regexp.html) -is supported. [RE2](https://github.com/google/re2/wiki/Syntax) limits the set of features -provided due to computational complexity, which means some features became unavailable in GitLab 11.9.4. -For example, negative lookaheads. +[RE2](https://github.com/google/re2/wiki/Syntax) limits the set of available features +due to computational complexity, and some features, like negative lookaheads, became unavailable. +Only a subset of features provided by [Ruby Regexp](https://ruby-doc.org/core/Regexp.html) +are now supported. -For GitLab versions from 11.9.7 and up to GitLab 12.0, GitLab provides a feature flag that can be -enabled by administrators that allows users to use unsafe regexp syntax. This brings compatibility -with previously allowed syntax version and allows users to gracefully migrate to the new syntax. +From GitLab 11.9.7 to GitLab 12.0, GitLab provided a feature flag to +let you use the unsafe regexp syntax. This flag allowed +compatibility with the previous syntax version so you could gracefully migrate to the new syntax. ```ruby Feature.enable(:allow_unsafe_ruby_regexp) @@ -1727,10 +1712,6 @@ Feature.enable(:allow_unsafe_ruby_regexp) ### `only`/`except` (advanced) -CAUTION: **Warning:** -This is an _alpha_ feature, and is subject to change at any time without -prior notice! - GitLab supports both simple and complex strategies, so it's possible to use an array and a hash configuration scheme. @@ -1741,7 +1722,7 @@ Four keys are available: - `changes` - `kubernetes` -If you use multiple keys under `only` or `except`, the keys will be evaluated as a +If you use multiple keys under `only` or `except`, the keys are evaluated as a single conjoined expression. That is: - `only:` includes the job if **all** of the keys have at least one condition that matches. @@ -1752,9 +1733,9 @@ the pipeline if the following is true: - `(any listed refs are true) AND (any listed variables are true) AND (any listed changes are true) AND (any chosen Kubernetes status matches)` -In the example below, the `test` job will `only` be created when **all** of the following are true: +In the example below, the `test` job is `only` created when **all** of the following are true: -- The pipeline has been [scheduled](../../user/project/pipelines/schedules.md) **or** runs for `master`. +- The pipeline has been [scheduled](../pipelines/schedules.md) **or** runs for `master`. - The `variables` keyword matches. - The `kubernetes` service is active on the project. @@ -1775,7 +1756,7 @@ added if the following is true: - `(any listed refs are true) OR (any listed variables are true) OR (any listed changes are true) OR (a chosen Kubernetes status matches)` -In the example below, the `test` job will **not** be created when **any** of the following are true: +In the example below, the `test` job is **not** created when **any** of the following are true: - The pipeline runs for the `master` branch. - There are changes to the `README.md` file in the root directory of the repository. @@ -1797,8 +1778,8 @@ test: The `refs` strategy can take the same values as the [simplified only/except configuration](#onlyexcept-basic). -In the example below, the `deploy` job is going to be created only when the -pipeline has been [scheduled](../pipelines/schedules.md) or runs for the `master` branch: +In the example below, the `deploy` job is created only when the +pipeline is [scheduled](../pipelines/schedules.md) or runs for the `master` branch: ```yaml deploy: @@ -1814,7 +1795,7 @@ deploy: The `kubernetes` strategy accepts only the `active` keyword. -In the example below, the `deploy` job is going to be created only when the +In the example below, the `deploy` job is created only when the Kubernetes service is active in the project: ```yaml @@ -1827,12 +1808,11 @@ deploy: > `variables` policy introduced in GitLab 10.7. -The `variables` keyword is used to define variables expressions. In other words, -you can use predefined variables / project / group or -environment-scoped variables to define an expression GitLab is going to -evaluate in order to decide whether a job should be created or not. +The `variables` keyword defines variable expressions. + +These expressions determine whether or not a job should be created. -Examples of using variables expressions: +Examples of using variable expressions: ```yaml deploy: @@ -1902,22 +1882,21 @@ docker build: - more_scripts/*.{rb,py,sh} ``` -In the scenario above, when pushing commits to an existing branch in GitLab, -it creates and triggers the `docker build` job, provided that one of the -commits contains changes to any of the following: +When you push commits to an existing branch, +the `docker build` job is created, but only if changes were made to any of the following: - The `Dockerfile` file. -- Any of the files inside `docker/scripts/` directory. -- Any of the files and subdirectories inside the `dockerfiles` directory. -- Any of the files with `rb`, `py`, `sh` extensions inside the `more_scripts` directory. +- Any of the files in the `docker/scripts/` directory. +- Any of the files and subdirectories in the `dockerfiles` directory. +- Any of the files with `rb`, `py`, `sh` extensions in the `more_scripts` directory. CAUTION: **Warning:** -If using `only:changes` with [only allow merge requests to be merged if the pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds), -undesired behavior could result if you don't [also use `only:merge_requests`](#using-onlychanges-with-pipelines-for-merge-requests). +If you use `only:changes` with [only allow merge requests to be merged if the pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds), +you should [also use `only:merge_requests`](#using-onlychanges-with-pipelines-for-merge-requests). Otherwise it may not work as expected. You can also use glob patterns to match multiple files in either the root directory -of the repository, or in _any_ directory within the repository, but they must be wrapped -in double quotes or GitLab will fail to parse the `.gitlab-ci.yml`. For example: +of the repository, or in _any_ directory within the repository. However, they must be wrapped +in double quotes or GitLab can't parse them. For example: ```yaml test: @@ -1930,10 +1909,8 @@ test: - "**/*.sql" ``` -The following example will skip the `build` job if a change is detected in any file -in the root directory of the repository with a `.md` extension. This mean that if you change multiple files, -but only one file is a `.md` file, the `build` job will still be skipped and will -not run for the other files. +You can skip a job if a change is detected in any file with a +`.md` extension in the root directory of the repository: ```yaml build: @@ -1943,13 +1920,13 @@ build: - "*.md" ``` -CAUTION: **Warning:** -There are some points to be aware of when -[using this feature with new branches or tags *without* pipelines for merge requests](#using-onlychanges-without-pipelines-for-merge-requests). +If you change multiple files, but only one file ends in `.md`, +the `build` job is still skipped. The job does not run for any of the files. -CAUTION: **Warning:** -There are some points to be aware of when -[using this feature with scheduled pipelines](#using-onlychanges-with-scheduled-pipelines). +Read more about how to use this feature with: + +- [New branches or tags *without* pipelines for merge requests](#using-onlychanges-without-pipelines-for-merge-requests). +- [Scheduled pipelines](#using-onlychanges-with-scheduled-pipelines). ##### Using `only:changes` with pipelines for merge requests @@ -1957,7 +1934,7 @@ With [pipelines for merge requests](../merge_request_pipelines/index.md), it's possible to define a job to be created based on files modified in a merge request. -In order to deduce the correct base SHA of the source branch, we recommend combining +To deduce the correct base SHA of the source branch, we recommend combining this keyword with `only: [merge_requests]`. This way, file differences are correctly calculated from any further commits, thus all changes in the merge requests are properly tested in pipelines. @@ -1975,13 +1952,9 @@ docker build service one: - service-one/**/* ``` -In the scenario above, if a merge request is created or updated that changes -either files in `service-one` directory or the `Dockerfile`, GitLab creates -and triggers the `docker build service one` job. - -Note that if [pipelines for merge requests](../merge_request_pipelines/index.md) is -combined with `only: [change]`, but `only: [merge_requests]` is omitted, there could be -unwanted behavior. +In this scenario, if a merge request changes +files in the `service-one` directory or the `Dockerfile`, GitLab creates +the `docker build service one` job. For example: @@ -1994,15 +1967,17 @@ docker build service one: - service-one/**/* ``` -In the example above, a pipeline could fail due to changes to a file in `service-one/**/*`. -A later commit could then be pushed that does not include any changes to this file, -but includes changes to the `Dockerfile`, and this pipeline could pass because it's only -testing the changes to the `Dockerfile`. GitLab checks the **most recent pipeline**, -that **passed**, and will show the merge request as mergeable, despite the earlier -failed pipeline caused by a change that was not yet corrected. +In the example above, the pipeline might fail because of changes to a file in `service-one/**/*`. + +A later commit that doesn't have changes in `service-one/**/*` +but does have changes to the `Dockerfile` can pass. The job +only tests the changes to the `Dockerfile`. -With this configuration, care must be taken to check that the most recent pipeline -properly corrected any failures from previous pipelines. +GitLab checks the **most recent pipeline** that **passed**. If the merge request is mergeable, +it doesn't matter that an earlier pipeline failed because of a change that has not been corrected. + +When you use this configuration, ensure that the most recent pipeline +properly corrects any failures from previous pipelines. ##### Using `only:changes` without pipelines for merge requests @@ -2068,15 +2043,15 @@ production: This example creates four paths of execution: -- Linter: the `lint` job will run immediately without waiting for the `build` stage to complete because it has no needs (`needs: []`). +- Linter: the `lint` job runs immediately without waiting for the `build` stage to complete because it has no needs (`needs: []`). -- Linux path: the `linux:rspec` and `linux:rubocop` jobs will be run as soon +- Linux path: the `linux:rspec` and `linux:rubocop` jobs runs as soon as the `linux:build` job finishes without waiting for `mac:build` to finish. -- macOS path: the `mac:rspec` and `mac:rubocop` jobs will be run as soon +- macOS path: the `mac:rspec` and `mac:rubocop` jobs runs as soon as the `mac:build` job finishes, without waiting for `linux:build` to finish. -- The `production` job will be executed as soon as all previous jobs +- The `production` job runs as soon as all previous jobs finish; in this case: `linux:build`, `linux:rspec`, `linux:rubocop`, `mac:build`, `mac:rspec`, `mac:rubocop`. @@ -2084,14 +2059,14 @@ This example creates four paths of execution: - If `needs:` is set to point to a job that is not instantiated because of `only/except` rules or otherwise does not exist, the - pipeline will be created with YAML error. + pipeline is not created and a YAML error is shown. - The maximum number of jobs that a single job can need in the `needs:` array is limited: - For GitLab.com, the limit is 50. For more information, see our [infrastructure issue](https://gitlab.com/gitlab-com/gl-infra/infrastructure/-/issues/7541). - For self-managed instances, the limit is: 50. This limit [can be changed](#changing-the-needs-job-limit). - If `needs:` refers to a job that is marked as `parallel:`. - the current job will depend on all parallel jobs created. -- `needs:` is similar to `dependencies:` in that it needs to use jobs from prior stages, + the current job depends on all parallel jobs being created. +- `needs:` is similar to `dependencies:` in that it must use jobs from prior stages, meaning it's impossible to create circular dependencies. Depending on jobs in the current stage is not possible either, but support [is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/30632). - Related to the above, stages must be explicitly defined for all jobs @@ -2108,8 +2083,7 @@ can choose a custom limit. For example, to set the limit to 100: Plan.default.actual_limits.update!(ci_needs_size_limit: 100) ``` -NOTE: **Note:** -To disable the ability to use DAG, set the limit to `0`. +To disable directed acyclic graphs (DAG), set the limit to `0`. #### Artifact downloads with `needs` @@ -2117,12 +2091,12 @@ To disable the ability to use DAG, set the limit to `0`. When using `needs`, artifact downloads are controlled with `artifacts: true` (default) or `artifacts: false`. -Since GitLab 12.6, you can't combine the [`dependencies`](#dependencies) keyword +In GitLab 12.6 and later, you can't combine the [`dependencies`](#dependencies) keyword with `needs` to control artifact downloads in jobs. `dependencies` is still valid in jobs that do not use `needs`. -In the example below, the `rspec` job will download the `build_job` artifacts, while the -`rubocop` job won't: +In the example below, the `rspec` job downloads the `build_job` artifacts, while the +`rubocop` job doesn't: ```yaml build_job: @@ -2144,9 +2118,9 @@ rubocop: artifacts: false ``` -Additionally, in the three syntax examples below, the `rspec` job will download the artifacts -from all three `build_jobs`, as `artifacts` is true for `build_job_1`, and will -**default** to true for both `build_job_2` and `build_job_3`. +Additionally, in the three syntax examples below, the `rspec` job downloads the artifacts +from all three `build_jobs`. `artifacts` is true for `build_job_1` and +**defaults** to true for both `build_job_2` and `build_job_3`. ```yaml rspec: @@ -2161,9 +2135,10 @@ rspec: > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14311) in GitLab v12.7. -`needs` can be used to download artifacts from up to five jobs in pipelines on -[other refs in the same project](#artifact-downloads-between-pipelines-in-the-same-project), -or pipelines in different projects, groups and namespaces: +Use `needs` to download artifacts from up to five jobs in pipelines: + +- [On other refs in the same project](#artifact-downloads-between-pipelines-in-the-same-project). +- In different projects, groups and namespaces. ```yaml build_job: @@ -2177,7 +2152,7 @@ build_job: artifacts: true ``` -`build_job` will download the artifacts from the latest successful `build-1` job +`build_job` downloads the artifacts from the latest successful `build-1` job on the `master` branch in the `group/project-name` project. If the project is in the same group or namespace, you can omit them from the `project:` key. For example, `project: group/project-name` or `project: project-name`. @@ -2186,9 +2161,10 @@ The user running the pipeline must have at least `reporter` access to the group ##### Artifact downloads between pipelines in the same project -`needs` can be used to download artifacts from different pipelines in the current project -by setting the `project` keyword as the current project's name, and specifying a ref. -In the example below, `build_job` will download the artifacts for the latest successful +Use `needs` to download artifacts from different pipelines in the current project. +Set the `project` keyword as the current project's name, and specify a ref. + +In this example, `build_job` downloads the artifacts for the latest successful `build-1` job with the `other-ref` ref: ```yaml @@ -2220,7 +2196,6 @@ build_job: artifacts: true ``` -NOTE: **Note:** Downloading artifacts from jobs that are run in [`parallel:`](#parallel) is not supported. ### `tags` @@ -2232,7 +2207,7 @@ When you register a runner, you can specify the runner's tags, for example `ruby`, `postgres`, `development`. In this example, the job is run by a runner that -has both `ruby` AND `postgres` tags defined. +has both `ruby` and `postgres` tags defined. ```yaml job: @@ -2271,16 +2246,16 @@ The default value is `false`, except for [manual](#whenmanual) jobs using the `when: manual` syntax, unless using [`rules:`](#rules) syntax, where all jobs default to false, *including* `when: manual` jobs. -When enabled and the job fails, the job will show an orange warning in the UI. -However, the logical flow of the pipeline will consider the job a +When `allow_failure` is enabled and the job fails, the job shows an orange warning in the UI. +However, the logical flow of the pipeline considers the job a success/passed, and is not blocked. -Assuming all other jobs are successful, the job's stage and its pipeline will -show the same orange warning. However, the associated commit will be marked +Assuming all other jobs are successful, the job's stage and its pipeline +show the same orange warning. However, the associated commit is marked as "passed", without warnings. -In the example below, `job1` and `job2` will run in parallel, but if `job1` -fails, it won't stop the next stage from running, since it's marked with +In the example below, `job1` and `job2` run in parallel, but if `job1` +fails, it doesn't stop the next stage from running, because it's marked with `allow_failure: true`: ```yaml @@ -2309,15 +2284,15 @@ failure. `when` can be set to one of the following values: 1. `on_success` - execute job only when all jobs from prior stages - succeed (or are considered succeeding because they are marked - `allow_failure`). This is the default. + succeed (or are considered succeeding because they have `allow_failure: true`). + This is the default. 1. `on_failure` - execute job only when at least one job from prior stages fails. 1. `always` - execute job regardless of the status of jobs from prior stages. 1. `manual` - execute job manually (added in GitLab 8.10). Read about - [manual actions](#whenmanual) below. + [manual jobs](#whenmanual) below. 1. `delayed` - execute job after a certain period (added in GitLab 11.14). - Read about [delayed actions](#whendelayed) below. + Read about [delayed jobs](#whendelayed) below. 1. `never`: - With [`rules`](#rules), don't execute job. - With [`workflow:rules`](#workflowrules), don't run pipeline. @@ -2371,45 +2346,44 @@ The above script: #### `when:manual` > - Introduced in GitLab 8.10. -> - Blocking manual actions were introduced in GitLab 9.0. +> - Blocking manual jobs were introduced in GitLab 9.0. > - Protected actions were introduced in GitLab 9.2. -Manual actions are a special type of job that are not executed automatically, -they need to be explicitly started by a user. An example usage of manual actions -would be a deployment to a production environment. Manual actions can be started -from the pipeline, job, environment, and deployment views. Read more at the -[environments documentation](../environments/index.md#configuring-manual-deployments). +A manual job is a type of job that is not executed automatically and must be explicitly +started by a user. You might want to use manual jobs for things like deploying to production. -Manual actions can be either optional or blocking. Blocking manual actions will -block the execution of the pipeline at the stage this action is defined in. It's -possible to resume execution of the pipeline when someone executes a blocking -manual action by clicking a _play_ button. +To make a job manual, add `when: manual` to its configuration. -When a pipeline is blocked, it won't be merged if Merge When Pipeline Succeeds -is set. Blocked pipelines also do have a special status, called _manual_. -When the `when:manual` syntax is used, manual actions are non-blocking by -default. If you want to make manual action blocking, it's necessary to add -`allow_failure: false` to the job's definition in `.gitlab-ci.yml`. +Manual jobs can be started from the pipeline, job, [environment](../environments/index.md#configuring-manual-deployments), +and deployment views. -Optional manual actions have `allow_failure: true` set by default and their -Statuses don't contribute to the overall pipeline status. So, if a manual -action fails, the pipeline will eventually succeed. +Manual jobs can be either optional or blocking: -NOTE: **Note:** -When using [`rules:`](#rules), `allow_failure` defaults to `false`, including for manual jobs. +- **Optional**: Manual jobs have [`allow_failure: true](#allow_failure) set by default + and are considered optional. The status of an optional manual job does not contribute + to the overall pipeline status. A pipeline can succeed even if all its manual jobs fail. -Manual actions are considered to be write actions, so permissions for -[protected branches](../../user/project/protected_branches.md) are used when -a user wants to trigger an action. In other words, in order to trigger a manual -action assigned to a branch that the pipeline is running for, the user needs to -have the ability to merge to this branch. It's possible to use protected environments -to more strictly [protect manual deployments](#protecting-manual-jobs) from being -run by unauthorized users. +- **Blocking**: To make a blocking manual job, add `allow_failure: false` to its configuration. + Blocking manual jobs stop further execution of the pipeline at the stage where the + job is defined. To let the pipeline continue running, click **{play}** (play) on + the blocking manual job. -NOTE: **Note:** -Using `when:manual` and `trigger` together results in the error `jobs:#{job-name} when -should be on_success, on_failure or always`, because `when:manual` prevents triggers -being used. + Merge requests in projects with [merge when pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md) + enabled can't be merged with a blocked pipeline. Blocked pipelines show a status + of **blocked**. + +When you use [`rules:`](#rules), `allow_failure` defaults to `false`, including for manual jobs. + +To trigger a manual job, a user must have permission to merge to the assigned branch. +You can use [protected branches](../../user/project/protected_branches.md) to more strictly +[protect manual deployments](#protecting-manual-jobs) from being run by unauthorized users. + +In [GitLab 13.5](https://gitlab.com/gitlab-org/gitlab/-/issues/201938) and later, you +can use `when:manual` in the same job as [`trigger`](#trigger). In GitLab 13.4 and +earlier, using them together causes the error `jobs:#{job-name} when should be on_success, on_failure or always`. +It is deployed behind the `:ci_manual_bridges` [feature flag](../../user/feature_flags.md), which is **enabled by default**. +[GitLab administrators with access to the Rails console](../../administration/feature_flags.md) +can opt to disable it. ##### Protecting manual jobs **(PREMIUM)** @@ -2441,12 +2415,12 @@ To do this, you must: 1. In the [protected environments settings](../environments/protected_environments.md#protecting-environments), select the environment (`production` in the example above) and add the users, roles or groups that are authorized to trigger the manual job to the **Allowed to Deploy** list. Only those in - this list will be able to trigger this manual job, as well as GitLab administrators + this list can trigger this manual job, as well as GitLab administrators who are always able to use protected environments. -Additionally, if a manual job is defined as blocking by adding `allow_failure: false`, -the next stages of the pipeline won't run until the manual job is triggered. This -can be used as a way to have a defined list of users allowed to "approve" later pipeline +Additionally, if you define a manual job as blocking by adding `allow_failure: false`, +the pipeline's next stages don't run until the manual job is triggered. You can use this +to define a list of users allowed to "approve" later pipeline stages by triggering the blocking manual job. #### `when:delayed` @@ -2465,11 +2439,11 @@ provided. `start_in` key must be less than or equal to one week. Examples of val - `1 day` - `1 week` -When there is a delayed job in a stage, the pipeline won't progress until the delayed job has finished. +When there is a delayed job in a stage, the pipeline doesn't progress until the delayed job has finished. This means this keyword can also be used for inserting delays between different stages. The timer of a delayed job starts immediately after the previous stage has completed. -Similar to other types of jobs, a delayed job's timer won't start unless the previous stage passed. +Similar to other types of jobs, a delayed job's timer doesn't start unless the previous stage passed. The following example creates a job named `timed rollout 10%` that is executed 30 minutes after the previous stage has completed: @@ -2482,7 +2456,7 @@ timed rollout 10%: ``` You can stop the active timer of a delayed job by clicking the **{time-out}** (**Unschedule**) button. -This job will never be executed in the future unless you execute the job manually. +This job can no longer be scheduled to run automatically. You can, however, execute the job manually. To start a delayed job immediately, click the **Play** button. Soon GitLab Runner picks up and starts the job. @@ -2495,7 +2469,7 @@ Soon GitLab Runner picks up and starts the job. `environment` is used to define that a job deploys to a specific environment. If `environment` is specified and no environment under that name exists, a new -one will be created automatically. +one is created automatically. In its simplest form, the `environment` keyword can be defined like: @@ -2506,7 +2480,7 @@ deploy to production: environment: production ``` -In the above example, the `deploy to production` job will be marked as doing a +In the above example, the `deploy to production` job is marked as doing a deployment to the `production` environment. #### `environment:name` @@ -2574,12 +2548,12 @@ deploy to production: > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/22191) in GitLab 8.13. > - Starting with GitLab 8.14, when you have an environment that has a stop action -> defined, GitLab will automatically trigger a stop action when the associated +> defined, GitLab automatically triggers a stop action when the associated > branch is deleted. -Closing (stopping) environments can be achieved with the `on_stop` keyword defined under -`environment`. It declares a different job that runs in order to close -the environment. +Closing (stopping) environments can be achieved with the `on_stop` keyword +defined under `environment`. It declares a different job that runs to close the +environment. Read the `environment:action` section for an example. @@ -2591,7 +2565,7 @@ The `action` keyword can be used to specify jobs that prepare, start, or stop en | **Value** | **Description** | |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| start | Default value. Indicates that job starts the environment. Deployment will be created after job starts. | +| start | Default value. Indicates that job starts the environment. The deployment is created after the job starts. | | prepare | Indicates that job is only preparing the environment. Does not affect deployments. [Read more about environments](../environments/index.md#prepare-an-environment) | | stop | Indicates that job stops deployment. See the example below. | @@ -2617,21 +2591,20 @@ stop_review_app: action: stop ``` -In the above example we set up the `review_app` job to deploy to the `review` -environment, and we also defined a new `stop_review_app` job under `on_stop`. -Once the `review_app` job is successfully finished, it will trigger the -`stop_review_app` job based on what is defined under `when`. In this case we -set it up to `manual` so it will need a [manual action](#whenmanual) via -GitLab's web interface in order to run. +In the above example, the `review_app` job deploys to the `review` +environment. A new `stop_review_app` job is listed under `on_stop`. +After the `review_app` job is finished, it triggers the +`stop_review_app` job based on what is defined under `when`. In this case, +it is set to `manual`, so it needs a [manual action](#whenmanual) from +GitLab's user interface to run. -Also in the example, `GIT_STRATEGY` is set to `none` so that GitLab Runner won’t -try to check out the code after the branch is deleted when the `stop_review_app` -job is [automatically triggered](../environments/index.md#automatically-stopping-an-environment). +Also in the example, `GIT_STRATEGY` is set to `none`. If the +`stop_review_app` job is [automatically triggered](../environments/index.md#automatically-stopping-an-environment), +the runner won’t try to check out the code after the branch is deleted. -NOTE: **Note:** -The above example overwrites global variables. If your stop environment job depends -on global variables, you can use [anchor variables](#yaml-anchors-for-variables) when setting the `GIT_STRATEGY` -to change it without overriding the global variables. +The example also overwrites global variables. If your `stop` `environment` job depends +on global variables, you can use [anchor variables](#yaml-anchors-for-variables) when you set the `GIT_STRATEGY`. +This changes the job without overriding the global variables. The `stop_review_app` job is **required** to have the following keywords defined: @@ -2640,10 +2613,12 @@ The `stop_review_app` job is **required** to have the following keywords defined - `environment:action` Additionally, both jobs should have matching [`rules`](../yaml/README.md#onlyexcept-basic) -or [`only/except`](../yaml/README.md#onlyexcept-basic) configuration. In the example -above, if the configuration is not identical, the `stop_review_app` job might not be -included in all pipelines that include the `review_app` job, and it will not be -possible to trigger the `action: stop` to stop the environment automatically. +or [`only/except`](../yaml/README.md#onlyexcept-basic) configuration. + +In the example above, if the configuration is not identical: + +- The `stop_review_app` job might not be included in all pipelines that include the `review_app` job. +- It is not possible to trigger the `action: stop` to stop the environment automatically. #### `environment:auto_stop_in` @@ -2687,7 +2662,7 @@ deploy: namespace: production ``` -This will set up the `deploy` job to deploy to the `production` +This configuration sets up the `deploy` job to deploy to the `production` environment, using the `production` [Kubernetes namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). @@ -2719,11 +2694,11 @@ deploy as review app: url: https://$CI_ENVIRONMENT_SLUG.example.com/ ``` -The `deploy as review app` job will be marked as deployment to dynamically +The `deploy as review app` job is marked as deployment to dynamically create the `review/$CI_COMMIT_REF_NAME` environment, where `$CI_COMMIT_REF_NAME` is an [environment variable](../variables/README.md) set by the runner. The `$CI_ENVIRONMENT_SLUG` variable is based on the environment name, but suitable -for inclusion in URLs. In this case, if the `deploy as review app` job was run +for inclusion in URLs. In this case, if the `deploy as review app` job is run in a branch named `pow`, this environment would be accessible with an URL like `https://review-pow.example.com/`. @@ -2742,16 +2717,15 @@ as Review Apps. You can see a simple example using Review Apps at > by default. > - From GitLab 9.2, caches are restored before [artifacts](#artifacts). -TIP: **Learn more:** -Read how caching works and find out some good practices in the -[caching dependencies documentation](../caching/index.md). - `cache` is used to specify a list of files and directories that should be cached between jobs. You can only use paths that are within the local working copy. If `cache` is defined outside the scope of jobs, it means it's set -globally and all jobs will use that definition. +globally and all jobs use that definition. + +Read how caching works and find out some good practices in the +[caching dependencies documentation](../caching/index.md). #### `cache:paths` @@ -2777,7 +2751,7 @@ rspec: ``` Locally defined cache overrides globally defined options. The following `rspec` -job will cache only `binaries/`: +job caches only `binaries/`: ```yaml cache: @@ -2792,20 +2766,20 @@ rspec: - binaries/ ``` -Note that since cache is shared between jobs, if you're using different -paths for different jobs, you should also set a different **cache:key** -otherwise cache content can be overwritten. +The cache is shared between jobs, so if you're using different +paths for different jobs, you should also set a different `cache:key`. +Otherwise cache content can be overwritten. #### `cache:key` > Introduced in GitLab Runner v1.0.0. -Since the cache is shared between jobs, if you're using different -paths for different jobs, you should also set a different `cache:key` -otherwise cache content can be overwritten. +The cache is shared between jobs, so if you're using different +paths for different jobs, you should also set a different `cache:key`. +Otherwise cache content can be overwritten. -The `key` parameter defines the affinity of caching between jobs, -to have a single cache for all jobs, cache per-job, cache per-branch +The `key` parameter defines the affinity of caching between jobs. +You can have a single cache for all jobs, cache per-job, cache per-branch, or any other way that fits your workflow. This way, you can fine tune caching, including caching data between different jobs or even different branches. @@ -2814,10 +2788,6 @@ The `cache:key` variable can use any of the set, is just literal `default`, which means everything is shared between pipelines and jobs by default, starting from GitLab 9.0. -NOTE: **Note:** -The `cache:key` variable can't contain the `/` character, or the equivalent -URI-encoded `%2F`; a value made only of dots (`.`, `%2E`) is also forbidden. - For example, to enable per-branch caching: ```yaml @@ -2837,18 +2807,23 @@ cache: - binaries/ ``` +The `cache:key` variable can't contain the `/` character, or the equivalent +URI-encoded `%2F`. A value made only of dots (`.`, `%2E`) is also forbidden. + +You can specify a [fallback cache key](#fallback-cache-key) to use if the specified `cache:key` is not found. + ##### `cache:key:files` > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18986) in GitLab v12.5. The `cache:key:files` keyword extends the `cache:key` functionality by making it easier -to reuse some caches, and rebuild them less often, which will speed up subsequent pipeline +to reuse some caches, and rebuild them less often, which speeds up subsequent pipeline runs. -When you include `cache:key:files`, you must also list the project files that will be used to generate the key, up to a maximum of two files. -The cache `key` will be a SHA checksum computed from the most recent commits (up to two, if two files are listed) +When you include `cache:key:files`, you must also list the project files that are used to generate the key, up to a maximum of two files. +The cache `key` is a SHA checksum computed from the most recent commits (up to two, if two files are listed) that changed the given files. If neither file was changed in any commits, -the fallback key will be `default`. +the fallback key is `default`. ```yaml cache: @@ -2864,7 +2839,7 @@ cache: In this example we're creating a cache for Ruby and Node.js dependencies that is tied to current versions of the `Gemfile.lock` and `package.json` files. Whenever one of these files changes, a new cache key is computed and a new cache is created. Any future -job runs using the same `Gemfile.lock` and `package.json` with `cache:key:files` will +job runs that use the same `Gemfile.lock` and `package.json` with `cache:key:files` use the new cache, instead of rebuilding the dependencies. ##### `cache:key:prefix` @@ -2897,11 +2872,11 @@ rspec: - bundle exec rspec ``` -For example, adding a `prefix` of `$CI_JOB_NAME` will -cause the key to look like: `rspec-feef9576d21ee9b6a32e30c5c79d0a0ceb68d1e5` and +For example, adding a `prefix` of `$CI_JOB_NAME` +causes the key to look like: `rspec-feef9576d21ee9b6a32e30c5c79d0a0ceb68d1e5` and the job cache is shared across different branches. If a branch changes -`Gemfile.lock`, that branch will have a new SHA checksum for `cache:key:files`. A new cache key -will be generated, and a new cache will be created for that key. +`Gemfile.lock`, that branch has a new SHA checksum for `cache:key:files`. A new cache key +is generated, and a new cache is created for that key. If `Gemfile.lock` is not found, the prefix is added to `default`, so the key in the example would be `rspec-default`. @@ -2928,6 +2903,28 @@ rspec: - binaries/ ``` +#### `cache:when` + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18969) in GitLab 13.5 and GitLab Runner v13.5.0. + +`cache:when` defines when to save the cache, based on the status of the job. You can +set `cache:when` to: + +- `on_success` - save the cache only when the job succeeds. This is the default. +- `on_failure` - save the cache only when the job fails. +- `always` - save the cache regardless of the job status. + +For example, to store a cache whether or not the job fails or succeeds: + +```yaml +rspec: + script: rspec + cache: + paths: + - rspec/ + when: 'always' +``` + #### `cache:policy` > Introduced in GitLab 9.4. @@ -2967,13 +2964,13 @@ rspec: - bundle exec rspec ... ``` -This helps to speed up job execution and reduce load on the cache server, -especially when you have a large number of cache-using jobs executing in +This helps to speed up job execution and reduce load on the cache server. +It is especially helpful when you have a large number of cache-using jobs executing in parallel. -Additionally, if you have a job that unconditionally recreates the cache without -reference to its previous contents, you can use `policy: push` in that job to -skip the download step. +If you have a job that unconditionally recreates the cache without +referring to its previous contents, you can skip the download step. +To do so, add `policy: push` to the job. ### `artifacts` @@ -2986,8 +2983,8 @@ skip the download step. `artifacts` is used to specify a list of files and directories that are attached to the job when it [succeeds, fails, or always](#artifactswhen). -The artifacts will be sent to GitLab after the job finishes and will -be available for download in the GitLab UI provided that the size is not +The artifacts are sent to GitLab after the job finishes. They are +available for download in the GitLab UI if the size is not larger than the [maximum artifact size](../../user/gitlab_com/index.md#gitlab-cicd). [Read more about artifacts](../pipelines/job_artifacts.md). @@ -3003,7 +3000,7 @@ patterns and: - In GitLab Runner 12.10 and earlier, [`filepath.Match`](https://pkg.go.dev/path/filepath/#Match). -To restrict which jobs a specific job will fetch artifacts from, see [dependencies](#dependencies). +To restrict which jobs a specific job fetches artifacts from, see [dependencies](#dependencies). Send all files in `binaries` and `.config`: @@ -3026,7 +3023,7 @@ job: You may want to create artifacts only for tagged releases to avoid filling the build server storage with temporary build artifacts. -Create artifacts only for tags (`default-job` won't create artifacts): +Create artifacts only for tags (`default-job` doesn't create artifacts): ```yaml default-job: @@ -3098,10 +3095,10 @@ test: paths: ['file.txt'] ``` -With this configuration, GitLab will add a link **artifact 1** to the relevant merge request +With this configuration, GitLab adds a link **artifact 1** to the relevant merge request that points to `file1.txt`. -An example that will match an entire directory: +An example that matches an entire directory: ```yaml test: @@ -3116,12 +3113,12 @@ Note the following: - Artifacts do not display in the merge request UI when using variables to define the `artifacts:paths`. - A maximum of 10 job artifacts per merge request can be exposed. - Glob patterns are unsupported. -- If a directory is specified, the link will be to the job [artifacts browser](../pipelines/job_artifacts.md#browsing-artifacts) if there is more than +- If a directory is specified, the link is to the job [artifacts browser](../pipelines/job_artifacts.md#browsing-artifacts) if there is more than one file in the directory. - For exposed single file artifacts with `.html`, `.htm`, `.txt`, `.json`, `.xml`, and `.log` extensions, if [GitLab Pages](../../administration/pages/index.md) is: - - Enabled, GitLab will automatically render the artifact. - - Not enabled, you will see the file in the artifacts browser. + - Enabled, GitLab automatically renders the artifact. + - Not enabled, the file is displayed in the artifacts browser. #### `artifacts:name` @@ -3133,11 +3130,6 @@ useful when you want to download the archive from GitLab. The `artifacts:name` variable can make use of any of the [predefined variables](../variables/README.md). The default name is `artifacts`, which becomes `artifacts.zip` when you download it. -NOTE: **Note:** -If your branch-name contains forward slashes -(for example `feature/my-feature`) it's advised to use `$CI_COMMIT_REF_SLUG` -instead of `$CI_COMMIT_REF_NAME` for proper naming of the artifact. - To create an archive with a name of the current job: ```yaml @@ -3159,6 +3151,10 @@ job: - binaries/ ``` +If your branch-name contains forward slashes +(for example `feature/my-feature`) it's advised to use `$CI_COMMIT_REF_SLUG` +instead of `$CI_COMMIT_REF_NAME` for proper naming of the artifact. + To create an archive with a name of the current job and the current branch or tag including only the binaries directory: @@ -3207,10 +3203,8 @@ job: #### `artifacts:untracked` `artifacts:untracked` is used to add all Git untracked files as artifacts (along -to the paths defined in `artifacts:paths`). - -NOTE: **Note:** -`artifacts:untracked` ignores configuration in the repository's `.gitignore` file. +to the paths defined in `artifacts:paths`). `artifacts:untracked` ignores configuration +in the repository's `.gitignore` file. Send all Git untracked files: @@ -3250,7 +3244,7 @@ failure. 1. `on_failure` - upload artifacts only when the job fails. 1. `always` - upload artifacts regardless of the job status. -To upload artifacts only when job fails: +For example, to upload artifacts only when a job fails: ```yaml job: @@ -3300,7 +3294,6 @@ job: expire_in: 1 week ``` -NOTE: **Note:** The latest artifacts for refs are locked against deletion, and kept regardless of the expiry time. [Introduced in](https://gitlab.com/gitlab-org/gitlab/-/issues/16267) GitLab 13.0 behind a disabled feature flag, and [made the default behavior](https://gitlab.com/gitlab-org/gitlab/-/issues/229936) @@ -3335,24 +3328,27 @@ These are the available report types: > Introduced in GitLab 8.6 and GitLab Runner v1.1.1. -By default, all [`artifacts`](#artifacts) from all previous [stages](#stages) -are passed, but you can use the `dependencies` parameter to define a limited -list of jobs (or no jobs) to fetch artifacts from. +By default, all [`artifacts`](#artifacts) from previous [stages](#stages) +are passed to each job. However, you can use the `dependencies` parameter to +define a limited list of jobs to fetch artifacts from. You can also set a job to download no artifacts at all. To use this feature, define `dependencies` in context of the job and pass a list of all previous jobs the artifacts should be downloaded from. -You can only define jobs from stages that are executed before the current one. -An error will be shown if you define jobs from the current stage or next ones. -Defining an empty array will skip downloading any artifacts for that job. -The status of the previous job is not considered when using `dependencies`, so -if it failed or it's a manual job that was not run, no error occurs. -In the following example, we define two jobs with artifacts, `build:osx` and +You can define jobs from stages that were executed before the current one. +An error occurs if you define jobs from the current or an upcoming stage. + +To prevent a job from downloading artifacts, define an empty array. + +When you use `dependencies`, the status of the previous job is not considered. +If a job fails or it's a manual job that was not run, no error occurs. + +The following example defines two jobs with artifacts: `build:osx` and `build:linux`. When the `test:osx` is executed, the artifacts from `build:osx` -will be downloaded and extracted in the context of the build. The same happens +are downloaded and extracted in the context of the build. The same happens for `test:linux` and artifacts from `build:linux`. -The job `deploy` will download artifacts from all previous jobs because of +The job `deploy` downloads artifacts from all previous jobs because of the [stage](#stages) precedence: ```yaml @@ -3387,16 +3383,15 @@ deploy: script: make deploy ``` -##### When a dependent job will fail +##### When a dependent job fails > Introduced in GitLab 10.3. If the artifacts of the job that is set as a dependency have been [expired](#artifactsexpire_in) or [erased](../pipelines/job_artifacts.md#erasing-artifacts), then -the dependent job will fail. +the dependent job fails. -NOTE: **Note:** You can ask your administrator to [flip this switch](../../administration/job_artifacts.md#validation-for-dependencies) and bring back the old behavior. @@ -3409,7 +3404,7 @@ Use `coverage` to configure how code coverage is extracted from the job output. Regular expressions are the only valid kind of value expected here. So, using -surrounding `/` is mandatory in order to consistently and explicitly represent +surrounding `/` is mandatory to consistently and explicitly represent a regular expression string. You must escape special characters if you want to match them literally. @@ -3426,17 +3421,17 @@ job1: > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/3442) in GitLab 9.5. > - [Behavior expanded](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3515) in GitLab 11.5 to control which failures to retry on. -Use `retry` to configure how many times a job is going to be retried in +Use `retry` to configure how many times a job is retried in case of a failure. -When a job fails and has `retry` configured, it's going to be processed again -up to the amount of times specified by the `retry` keyword. +When a job fails, the job is processed again, +until the limit specified by the `retry` keyword is reached. -If `retry` is set to 2, and a job succeeds in a second run (first retry), it won't be retried -again. `retry` value has to be a positive integer, equal or larger than 0, but -lower or equal to 2 (two retries maximum, three runs in total). +If `retry` is set to `2`, and a job succeeds in a second run (first retry), it is not retried. +The `retry` value must be a positive integer, from `0` to `2` +(two retries maximum, three runs in total). -A simple example to retry in all failure cases: +This example retries all failure cases: ```yaml test: @@ -3444,7 +3439,7 @@ test: retry: 2 ``` -By default, a job will be retried on all failure cases. To have a better control +By default, a job is retried on all failure cases. To have better control over which failures to retry, `retry` can be a hash with the following keys: - `max`: The maximum number of retries. @@ -3460,8 +3455,8 @@ test: when: runner_system_failure ``` -If there is another failure, other than a runner system failure, the job will -not be retried. +If there is another failure, other than a runner system failure, the job +is not retried. To retry on multiple failure cases, `when` can also be an array of failures: @@ -3478,10 +3473,10 @@ test: Possible values for `when` are: <!-- - Please make sure to update `RETRY_WHEN_IN_DOCUMENTATION` array in - `spec/lib/gitlab/ci/config/entry/retry_spec.rb` if you change any of - the documented values below. The test there makes sure that all documented - values are really valid as a configuration option and therefore should always + If you change any of the values below, make sure to update the `RETRY_WHEN_IN_DOCUMENTATION` + array in `spec/lib/gitlab/ci/config/entry/retry_spec.rb`. + The test there makes sure that all documented + values are valid as a configuration option and therefore should always stay in sync with this documentation. --> @@ -3543,7 +3538,6 @@ test: parallel: 5 ``` -TIP: **Tip:** Parallelize tests suites across parallel jobs. Different languages have different tools to facilitate this. @@ -3578,6 +3572,12 @@ job split into three separate jobs. Use `matrix:` to configure different variables for jobs that are running in parallel. There can be from 2 to 50 jobs. +[In GitLab 13.5](https://gitlab.com/gitlab-org/gitlab/-/issues/26362) and later, +you can have one-dimensional matrices with a single job. +The ability to have one-dimensional matrices is [deployed behind a feature flag](../../user/feature_flags.md), +enabled by default. It's enabled on GitLab.com. For self-managed GitLab instances, +administrators can opt to disable it by [disabling the `one_dimensional_matrix:` feature flag](../../administration/feature_flags.md). **(CORE ONLY)** + Every job gets the same `CI_NODE_TOTAL` [environment variable](../variables/README.md#predefined-environment-variables) value, and a unique `CI_NODE_INDEX` value. ```yaml @@ -3623,19 +3623,25 @@ Job naming style [was improved](https://gitlab.com/gitlab-org/gitlab/-/issues/23 Use `trigger` to define a downstream pipeline trigger. When GitLab starts a job created with a `trigger` definition, a downstream pipeline is created. +Jobs with `trigger` can only use a [limited set of keywords](../multi_project_pipelines.md#limitations). +For example, you can't run commands with [`script`](#script), [`before_script`](#before_script-and-after_script), +or [`after_script`](#before_script-and-after_script). + You can use this keyword to create two different types of downstream pipelines: - [Multi-project pipelines](../multi_project_pipelines.md#creating-multi-project-pipelines-from-gitlab-ciyml) - [Child pipelines](../parent_child_pipelines.md) -[Since GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/197140/), you can -see which job triggered a downstream pipeline by hovering your mouse cursor over -the downstream pipeline job in the [pipeline graph](../pipelines/index.md#visualize-pipelines). +[In GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/197140/) and later, you can +view which job triggered a downstream pipeline. In the [pipeline graph](../pipelines/index.md#visualize-pipelines), +hover over the downstream pipeline job. -NOTE: **Note:** -Using a `trigger` with `when:manual` together results in the error `jobs:#{job-name} -when should be on_success, on_failure or always`, because `when:manual` prevents -triggers being used. +In [GitLab 13.5](https://gitlab.com/gitlab-org/gitlab/-/issues/201938) and later, you +can use [`when:manual`](#whenmanual) in the same job as `trigger`. In GitLab 13.4 and +earlier, using them together causes the error `jobs:#{job-name} when should be on_success, on_failure or always`. +It is deployed behind the `:ci_manual_bridges` [feature flag](../../user/feature_flags.md), which is **enabled by default**. +[GitLab administrators with access to the Rails console](../../administration/feature_flags.md) +can opt to disable it. #### Simple `trigger` syntax for multi-project pipelines @@ -3654,7 +3660,7 @@ staging: #### Complex `trigger` syntax for multi-project pipelines -It's possible to configure a branch name that GitLab will use to create +You can configure a branch name that GitLab uses to create a downstream pipeline with: ```yaml @@ -3669,7 +3675,7 @@ staging: branch: stable ``` -It's possible to mirror the status from a triggered pipeline: +To mirror the status from a triggered pipeline: ```yaml trigger_job: @@ -3678,7 +3684,7 @@ trigger_job: strategy: depend ``` -It's possible to mirror the status from an upstream pipeline: +To mirror the status from an upstream pipeline: ```yaml upstream_bridge: @@ -3736,14 +3742,30 @@ child-pipeline: The `generated-config.yml` is extracted from the artifacts and used as the configuration for triggering the child pipeline. +##### Trigger child pipeline with files from another project + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205157) in GitLab 13.5. + +To trigger child pipelines with files from another private project under the same +GitLab instance, use [`include:file`](#includefile): + +```yaml +child-pipeline: + trigger: + include: + - project: 'my-group/my-pipeline-library' + ref: 'master' + file: '/path/to/child-pipeline.yml' +``` + #### Linking pipelines with `trigger:strategy` By default, the `trigger` job completes with the `success` status as soon as the downstream pipeline is created. To force the `trigger` job to wait for the downstream (multi-project or child) pipeline to complete, use -`strategy: depend`. This will make the trigger job wait with a "running" status until the triggered -pipeline completes. At that point, the `trigger` job will complete and display the same status as +`strategy: depend`. This setting makes the trigger job wait with a "running" status until the triggered +pipeline completes. At that point, the `trigger` job completes and displays the same status as the downstream job. ```yaml @@ -3753,16 +3775,16 @@ trigger_job: strategy: depend ``` -This can help keep your pipeline execution linear. In the example above, jobs from -subsequent stages will wait for the triggered pipeline to successfully complete before -starting, at the cost of reduced parallelization. +This setting can help keep your pipeline execution linear. In the example above, jobs from +subsequent stages wait for the triggered pipeline to successfully complete before +starting, which reduces parallelization. #### Trigger a pipeline by API call -Triggers can be used to force a rebuild of a specific branch, tag or commit, -with an API call when a pipeline gets created using a trigger token. +To force a rebuild of a specific branch, tag, or commit, you can use an API call +with a trigger token. -Not to be confused with the [`trigger`](#trigger) parameter. +The trigger token is different than the [`trigger`](#trigger) parameter. [Read more in the triggers documentation.](../triggers/README.md) @@ -3771,19 +3793,18 @@ Not to be confused with the [`trigger`](#trigger) parameter. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32022) in GitLab 12.3. `interruptible` is used to indicate that a job should be canceled if made redundant by a newer pipeline run. Defaults to `false`. -This value will only be used if the [automatic cancellation of redundant pipelines feature](../pipelines/settings.md#auto-cancel-pending-pipelines) +This value is used only if the [automatic cancellation of redundant pipelines feature](../pipelines/settings.md#auto-cancel-pending-pipelines) is enabled. -When enabled, a pipeline on the same branch will be canceled when: +When enabled, a pipeline on the same branch is canceled when: - It's made redundant by a newer pipeline run. - Either all jobs are set as interruptible, or any uninterruptible jobs haven't started. -Pending jobs are always considered interruptible. - -TIP: **Tip:** Set jobs as interruptible that can be safely canceled once started (for instance, a build job). +Pending jobs are always considered interruptible. + Here is a simple example: ```yaml @@ -3806,17 +3827,16 @@ step-2: step-3: stage: stage3 script: - - echo "Because step-2 can not be canceled, this step will never be canceled, even though set as interruptible." + - echo "Because step-2 can not be canceled, this step can never be canceled, even though it's set as interruptible." interruptible: true ``` -In the example above, a new pipeline run will cause an existing running pipeline to be: +In the example above, a new pipeline run causes an existing running pipeline to be: - Canceled, if only `step-1` is running or pending. - Not canceled, once `step-2` starts running. -NOTE: **Note:** -Once an uninterruptible job is running, the pipeline will never be canceled, regardless of the final job's state. +When an uninterruptible job is running, the pipeline can never be canceled, regardless of the final job's state. ### `resource_group` @@ -3826,12 +3846,13 @@ Sometimes running multiple jobs or pipelines at the same time in an environment can lead to errors during the deployment. To avoid these errors, the `resource_group` attribute can be used to ensure that -the runner doesn't run certain jobs simultaneously. +the runner doesn't run certain jobs simultaneously. Resource groups behave similar +to semaphores in other programming languages. When the `resource_group` key is defined for a job in `.gitlab-ci.yml`, job executions are mutually exclusive across different pipelines for the same project. If multiple jobs belonging to the same resource group are enqueued simultaneously, -only one of the jobs is picked by the runner, and the other jobs wait until the +only one of the jobs is picked by the runner. The other jobs wait until the `resource_group` is free. Here is a simple example: @@ -3842,17 +3863,14 @@ deploy-to-production: resource_group: production ``` -In this case, if a `deploy-to-production` job is running in a pipeline, and a new -`deploy-to-production` job is created in a different pipeline, it won't run until -the currently running/pending `deploy-to-production` job is finished. As a result, -you can ensure that concurrent deployments will never happen to the production environment. +In this case, two `deploy-to-production` jobs in two separate pipelines can never run at the same time. As a result, +you can ensure that concurrent deployments never happen to the production environment. There can be multiple `resource_group`s defined per environment. A good use case for this -is when deploying to physical devices. You may have more than one physical device, and each -one can be deployed to, but there can be only one deployment per device at any given time. +is when deploying to physical devices. You may have multiple physical devices that +can be deployed to, but there can be only one deployment per device at any given time. -NOTE: **Note:** -This key can only contain letters, digits, `-`, `_`, `/`, `$`, `{`, `}`, `.`, and spaces. +The `resource_group` value can only contain letters, digits, `-`, `_`, `/`, `$`, `{`, `}`, `.`, and spaces. It can't start or end with `/`. For more information, see [Deployments Safety](../environments/deployment_safety.md). @@ -3962,7 +3980,11 @@ The title of each milestone the release is associated with. #### `release:released_at` The date and time when the release is ready. Defaults to the current date and time if not -defined. Expected in ISO 8601 format (2019-03-15T08:00:00Z). +defined. Should be enclosed in quotes and expressed in ISO 8601 format. + +```json +released_at: '2021-03-15T08:00:00Z' +``` #### Complete example for `release` @@ -3990,7 +4012,7 @@ tags. These options cannot be used together, so choose one: - 'm1' - 'm2' - 'm3' - released_at: '2020-07-15T08:00:00Z' # Optional, will auto generate if not defined, or can use a variable. + released_at: '2020-07-15T08:00:00Z' # Optional, is auto generated if not defined, or can use a variable. ``` - To create a release automatically when commits are pushed or merged to the default branch, @@ -4036,9 +4058,14 @@ tags. These options cannot be used together, so choose one: - 'm1' - 'm2' - 'm3' - released_at: '2020-07-15T08:00:00Z' # Optional, will auto generate if not defined, or can use a variable. + released_at: '2020-07-15T08:00:00Z' # Optional, is auto generated if not defined, or can use a variable. ``` +#### Release assets as Generic packages + +You can use [Generic packages](../../user/packages/generic_packages/) to host your release assets. +For a complete example of how to do this, see the [example in the repository](https://gitlab.com/gitlab-org/release-cli/-/tree/master/docs/examples/release-assets-as-generic-package/). + #### `releaser-cli` command line The entries under the `:release` node are transformed into a `bash` command line and sent @@ -4056,14 +4083,16 @@ release-cli create --name "Release $CI_COMMIT_SHA" --description "Created using > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33014) in GitLab 13.4. `secrets` indicates the [CI Secrets](../secrets/index.md) this job needs. It should be a hash, -and the keys should be the names of the environment variables the job needs to access the secrets. +and the keys should be the names of the environment variables that are made available to the job. +The value of each secret is saved in a temporary file. This file's path is stored in these +environment variables. #### `secrets:vault` **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28321) in GitLab 13.4. `vault` keyword specifies secrets provided by [Hashicorp's Vault](https://www.vaultproject.io/). -This syntax has multiple forms. The shortest form asssumes the use of the +This syntax has multiple forms. The shortest form assumes the use of the [KV-V2](https://www.vaultproject.io/docs/secrets/kv/kv-v2) secrets engine, mounted at the default path `kv-v2`. The last part of the secret's path is the field to fetch the value for: @@ -4072,7 +4101,7 @@ field to fetch the value for: job: secrets: DATABASE_PASSWORD: - vault: production/db/password # translates to secret `kv-v2/data/production/db`, field `password` + vault: production/db/password # translates to secret `kv-v2/data/production/db`, field `password` ``` You can specify a custom secrets engine path by adding a suffix starting with `@`: @@ -4081,7 +4110,7 @@ You can specify a custom secrets engine path by adding a suffix starting with `@ job: secrets: DATABASE_PASSWORD: - vault: production/db/password@ops # translates to secret `ops/data/production/db`, field `password` + vault: production/db/password@ops # translates to secret `ops/data/production/db`, field `password` ``` In the detailed form of the syntax, you can specify all details explicitly: @@ -4131,34 +4160,40 @@ Read more on [GitLab Pages user documentation](../../user/project/pages/index.md > Introduced in GitLab Runner v0.5.0. -NOTE: **Note:** -Integers (as well as strings) are legal both for variable's name and value. -Floats are not legal and can't be used. +Variables are configurable values that are passed to jobs. They can be set +globally and per-job. + +There are two types of variables. + +- [Custom variables](../variables/README.md#custom-environment-variables): + You can define their values in the `.gitlab-ci.yml` file, in the GitLab UI, + or by using the API. +- [Predefined variables](../variables/predefined_variables.md): + These values are set by the runner itself. + One example is `CI_COMMIT_REF_NAME`, which is the branch or tag the project is built for. -Variables are configurable values in `.gitlab-ci.yml` that are passed to jobs. -They can be set globally and per-job. -When you use the `variables` keyword in jobs, it overrides the global -YAML variables and predefined ones of the same name. +After you define a variable, you can use it in all executed commands and scripts. -Variables are stored in the Git repository and are meant for non-sensitive -project configuration, for example: +Variables are meant for non-sensitive project configuration, for example: ```yaml variables: DATABASE_URL: "postgres://postgres@postgres/my_database" ``` -You can use these variables later in all executed commands and scripts. -The YAML-defined variables are also set to all created service containers, -so that you can fine tune them. +You can use integers and strings for the variable's name and value. +You cannot use floats. + +If you define a variable at the top level of the `gitlab-ci.yml` file, it is global, +meaning it applies to all jobs. + +If you define a variable within a job, it's available to that job only. -Except for the user-defined variables, there are also variables [set up by the -runner itself](../variables/README.md#predefined-environment-variables). -One example would be `CI_COMMIT_REF_NAME`, which has the value of -the branch or tag name the project is built for. Apart from the variables -you can set in `.gitlab-ci.yml`, there are also environment -[variables](../variables/README.md#gitlab-cicd-environment-variables), -which can be set in the GitLab UI. +If a variable of the same name is defined globally and for a specific job, the +[job-specific variable is used](../variables/README.md#priority-of-environment-variables). + +All YAML-defined variables are also set to any linked +[service containers](../docker/using_docker_images.md#what-is-a-service). [YAML anchors for variables](#yaml-anchors-for-variables) are available. @@ -4169,12 +4204,9 @@ Learn more about [variables and their priority](../variables/README.md). > - Introduced in GitLab 8.9 as an experimental feature. > - `GIT_STRATEGY=none` requires GitLab Runner v1.7+. -CAUTION: **Caution:** -May change or be removed completely in future releases. - You can set the `GIT_STRATEGY` used for getting recent application code, either globally or per-job in the [`variables`](#variables) section. If left -unspecified, the default from project settings will be used. +unspecified, the default from the project settings is used. There are three possible values: `clone`, `fetch`, and `none`. @@ -4195,10 +4227,11 @@ variables: GIT_STRATEGY: fetch ``` -`none` also re-uses the local working copy, but skips all Git operations -(including GitLab Runner's pre-clone script, if present). It's mostly useful -for jobs that operate exclusively on artifacts (for example, `deploy`). Git repository -data may be present, but it's certain to be out of date, so you should only +`none` also re-uses the local working copy. However, it skips all Git operations, +including GitLab Runner's pre-clone script, if present. + +It's useful for jobs that operate exclusively on artifacts, like a deployment job. +Git repository data may be present, but it's likely out-of-date. You should only rely on files brought into the local working copy from cache or artifacts. ```yaml @@ -4222,10 +4255,10 @@ globally or per-job in the [`variables`](#variables) section. There are three possible values: `none`, `normal`, and `recursive`: -- `none` means that submodules won't be included when fetching the project +- `none` means that submodules are not included when fetching the project code. This is the default, which matches the pre-v1.10 behavior. -- `normal` means that only the top-level submodules will be included. It's +- `normal` means that only the top-level submodules are included. It's equivalent to: ```shell @@ -4234,7 +4267,7 @@ There are three possible values: `none`, `normal`, and `recursive`: ``` - `recursive` means that all submodules (including submodules of submodules) - will be included. This feature needs Git v1.8.1 and later. When using a + are included. This feature needs Git v1.8.1 and later. When using a GitLab Runner with an executor not based on Docker, make sure the Git version meets that requirement. It's equivalent to: @@ -4243,7 +4276,7 @@ There are three possible values: `none`, `normal`, and `recursive`: git submodule update --init --recursive ``` -Note that for this feature to work correctly, the submodules must be configured +For this feature to work correctly, the submodules must be configured (in `.gitmodules`) with either: - the HTTP(S) URL of a publicly-accessible repository, or @@ -4259,15 +4292,15 @@ The `GIT_CHECKOUT` variable can be used when the `GIT_STRATEGY` is set to either specified, it defaults to true. You can set them globally or per-job in the [`variables`](#variables) section. -If set to `false`, the runner will: +If set to `false`, the runner: -- when doing `fetch` - update the repository and leave working copy on +- when doing `fetch` - updates the repository and leaves the working copy on the current revision, -- when doing `clone` - clone the repository and leave working copy on the +- when doing `clone` - clones the repository and leaves the working copy on the default branch. -Having this setting set to `true` will mean that for both `clone` and `fetch` -strategies the runner will checkout the working copy to a revision related +If `GIT_CHECKOUT` is set to `true`, both `clone` and `fetch` work the same way. +The runner checks out the working copy of a revision related to the CI pipeline: ```yaml @@ -4313,7 +4346,7 @@ script: The `GIT_FETCH_EXTRA_FLAGS` variable is used to control the behavior of `git fetch`. You can set it globally or per-job in the [`variables`](#variables) section. -`GIT_FETCH_EXTRA_FLAGS` accepts all possible options of the [`git fetch`](https://git-scm.com/docs/git-fetch) command, but please note that `GIT_FETCH_EXTRA_FLAGS` flags will be appended after the default flags that can't be modified. +`GIT_FETCH_EXTRA_FLAGS` accepts all options of the [`git fetch`](https://git-scm.com/docs/git-fetch) command. However, `GIT_FETCH_EXTRA_FLAGS` flags are appended after the default flags that can't be modified. The default flags are: @@ -4335,7 +4368,7 @@ script: - ls -al cache/ ``` -The configuration above will result in `git fetch` being called this way: +The configuration above results in `git fetch` being called this way: ```shell git fetch origin $REFSPECS --depth 50 --prune @@ -4347,13 +4380,13 @@ Where `$REFSPECS` is a value provided to the runner internally by GitLab. > Introduced in GitLab, it requires GitLab Runner v1.9+. -You can set the number for attempts the running job will try to execute each -of the following stages: +You can set the number of attempts that the running job tries to execute +the following stages: | Variable | Description | |-----------------------------------|--------------------------------------------------------| | **ARTIFACT_DOWNLOAD_ATTEMPTS** | Number of attempts to download artifacts running a job | -| **EXECUTOR_JOB_SECTION_ATTEMPTS** | [Since GitLab 12.10](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4450), the number of attempts to run a section in a job after a [`No Such Container`](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4450) error ([Docker executor](https://docs.gitlab.com/runner/executors/docker.html) only). | +| **EXECUTOR_JOB_SECTION_ATTEMPTS** | [In GitLab 12.10](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4450) and later, the number of attempts to run a section in a job after a [`No Such Container`](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4450) error ([Docker executor](https://docs.gitlab.com/runner/executors/docker.html) only). | | **GET_SOURCES_ATTEMPTS** | Number of attempts to fetch sources running a job | | **RESTORE_CACHE_ATTEMPTS** | Number of attempts to restore the cache running a job | @@ -4368,27 +4401,52 @@ variables: You can set them globally or per-job in the [`variables`](#variables) section. +### Fallback cache key + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/1534) in GitLab Runner 13.4. + +You can use the `$CI_COMMIT_REF_SLUG` variable to specify your [`cache:key`](#cachekey). +For example, if your `$CI_COMMIT_REF_SLUG` is `test` you can set a job +to download cache that's tagged with `test`. + +If a cache with this tag is not found, you can use `CACHE_FALLBACK_KEY` to +specify a cache to use when none exists. + +For example: + +```yaml +variables: + CACHE_FALLBACK_KEY: fallback-key + +cache: + key: "$CI_COMMIT_REF_SLUG" + paths: + - binaries/ +``` + +In this example, if the `$CI_COMMIT_REF_SLUG` is not found, the job uses the key defined +by the `CACHE_FALLBACK_KEY` variable. + ### Shallow cloning > Introduced in GitLab 8.9 as an experimental feature. -NOTE: **Note:** -As of GitLab 12.0, newly created projects will automatically have a [default `git depth` value of `50`](../pipelines/settings.md#git-shallow-clone). - -You can specify the depth of fetching and cloning using `GIT_DEPTH`. This does a -shallow clone of the repository and can significantly speed up cloning for -repositories with a large number of commits or old, large binaries. The value is +You can specify the depth of fetching and cloning using `GIT_DEPTH`. +`GIT_DEPTH` does a shallow clone of the repository and can significantly speed up cloning. +It can be helpful for repositories with a large number of commits or old, large binaries. The value is passed to `git fetch` and `git clone`. -NOTE: **Note:** -If you use a depth of 1 and have a queue of jobs or retry +In GitLab 12.0 and later, newly-created projects automatically have a +[default `git depth` value of `50`](../pipelines/settings.md#git-shallow-clone). + +If you use a depth of `1` and have a queue of jobs or retry jobs, jobs may fail. -Since Git fetching and cloning is based on a ref, such as a branch name, runners -can't clone a specific commit SHA. If there are multiple jobs in the queue, or -you're retrying an old job, the commit to be tested needs to be within the +Git fetching and cloning is based on a ref, such as a branch name, so runners +can't clone a specific commit SHA. If multiple jobs are in the queue, or +you're retrying an old job, the commit to be tested must be within the Git history that is cloned. Setting too small a value for `GIT_DEPTH` can make -it impossible to run these old commits. You will see `unresolved reference` in +it impossible to run these old commits and `unresolved reference` is displayed in job logs. You should then reconsider changing `GIT_DEPTH` to a higher value. Jobs that rely on `git describe` may not work correctly when `GIT_DEPTH` is @@ -4407,11 +4465,6 @@ You can set it globally or per-job in the [`variables`](#variables) section. > [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/2211) in GitLab Runner 11.10. -NOTE: **Note:** -This can only be used when `custom_build_dir` is enabled in the [runner's -configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscustom_build_dir-section). -This is the default configuration for `docker` and `kubernetes` executor. - By default, GitLab Runner clones the repository in a unique subpath of the `$CI_BUILDS_DIR` directory. However, your project might require the code in a specific directory (Go projects, for example). In that case, you can specify @@ -4431,12 +4484,17 @@ The `GIT_CLONE_PATH` has to always be within `$CI_BUILDS_DIR`. The directory set is dependent on executor and configuration of [runners.builds_dir](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section) setting. +This can only be used when `custom_build_dir` is enabled in the +[runner's configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscustom_build_dir-section). +This is the default configuration for the `docker` and `kubernetes` executors. + #### Handling concurrency -An executor using a concurrency greater than `1` might lead -to failures because multiple jobs might be working on the same directory if the `builds_dir` +An executor that uses a concurrency greater than `1` might lead +to failures. Multiple jobs might be working on the same directory if the `builds_dir` is shared between jobs. -GitLab Runner does not try to prevent this situation. It's up to the administrator + +The runner does not try to prevent this situation. It's up to the administrator and developers to comply with the requirements of runner configuration. To avoid this scenario, you can use a unique path within `$CI_BUILDS_DIR`, because runner @@ -4503,15 +4561,20 @@ need to be used to merge arrays. > Introduced in GitLab 8.6 and GitLab Runner v1.1.1. -YAML has a handy feature called 'anchors', which lets you easily duplicate -content across your document. Anchors can be used to duplicate/inherit -properties, and is a perfect example to be used with [hidden jobs](#hide-jobs) -to provide templates for your jobs. When there is duplicate keys, GitLab will -perform a reverse deep merge based on the keys. +YAML has a feature called 'anchors' that you can use to duplicate +content across your document. + +Use anchors to duplicate or inherit properties. Use anchors with [hidden jobs](#hide-jobs) +to provide templates for your jobs. When there are duplicate keys, GitLab +performs a reverse deep merge based on the keys. + +You can't use YAML anchors across multiple files when leveraging the [`include`](#include) +feature. Anchors are only valid within the file they were defined in. Instead +of using YAML anchors, you can use the [`extends` keyword](#extends). -The following example uses anchors and map merging. It will create two jobs, -`test1` and `test2`, that will inherit the parameters of `.job_template`, each -having their own custom `script` defined: +The following example uses anchors and map merging. It creates two jobs, +`test1` and `test2`, that inherit the parameters of `.job_template`, each +with their own custom `script` defined: ```yaml .job_template: &job_definition # Hidden key that defines an anchor named 'job_definition' @@ -4559,9 +4622,9 @@ test2: - test2 project ``` -Let's see another one example. This time we will use anchors to define two sets -of services. This will create two jobs, `test:postgres` and `test:mysql`, that -will share the `script` directive defined in `.job_template`, and the `services` +Let's see another example. This time we use anchors to define two sets +of services. This configuration creates two jobs, `test:postgres` and `test:mysql`, that +share the `script` directive defined in `.job_template`, and the `services` directive defined in `.postgres_services` and `.mysql_services` respectively: ```yaml @@ -4630,15 +4693,8 @@ test:mysql: - dev ``` -You can see that the hidden jobs are conveniently used as templates. - -NOTE: **Note:** -Note that `tags: [dev]` has been overwritten by `tags: [postgres]`. - -NOTE: **Note:** -You can't use YAML anchors across multiple files when leveraging the [`include`](#include) -feature. Anchors are only valid within the file they were defined in. Instead -of using YAML anchors, you can use the [`extends` keyword](#extends). +You can see that the hidden jobs are conveniently used as templates, and +`tags: [dev]` has been overwritten by `tags: [postgres]`. #### YAML anchors for `before_script` and `after_script` @@ -4692,7 +4748,7 @@ job_name: of variables across multiple jobs. It can also enable more flexibility when a job requires a specific `variables` block that would otherwise override the global variables. -In the example below, we will override the `GIT_STRATEGY` variable without affecting +In the example below, we override the `GIT_STRATEGY` variable without affecting the use of the `SAMPLE_VARIABLE` variable: ```yaml @@ -4701,7 +4757,7 @@ variables: &global-variables SAMPLE_VARIABLE: sample_variable_value ANOTHER_SAMPLE_VARIABLE: another_sample_variable_value -# a job that needs to set the GIT_STRATEGY variable, yet depend on global variables +# a job that must set the GIT_STRATEGY variable, yet depend on global variables job_no_git_strategy: stage: cleanup variables: @@ -4723,8 +4779,8 @@ lines where the job is defined: # - run test ``` -You can instead start its name with a dot (`.`) and it won't be processed by -GitLab CI/CD. In the following example, `.hidden_job` will be ignored: +Instead, you can start its name with a dot (`.`) and it is not processed by +GitLab CI/CD. In the following example, `.hidden_job` is ignored: ```yaml .hidden_job: @@ -4739,18 +4795,18 @@ into templates. ## Skip Pipeline If your commit message contains `[ci skip]` or `[skip ci]`, using any -capitalization, the commit will be created but the pipeline will be skipped. +capitalization, the commit is created but the pipeline is skipped. Alternatively, one can pass the `ci.skip` [Git push option](../../user/project/push_options.md#push-options-for-gitlab-cicd) if using Git 2.10 or newer. ## Processing Git pushes -GitLab will create at most 4 branch and tag pipelines when -pushing multiple changes in single `git push` invocation. +GitLab creates at most four branch and tag pipelines when +pushing multiple changes in a single `git push` invocation. -This limitation does not affect any of the updated Merge Request pipelines. -All updated Merge Requests will have a pipeline created when using +This limitation does not affect any of the updated merge request pipelines. +All updated merge requests have a pipeline created when using [pipelines for merge requests](../merge_request_pipelines/index.md). ## Deprecated parameters diff --git a/doc/ci/yaml/img/ci_config_visualization_hover_v13_5.png b/doc/ci/yaml/img/ci_config_visualization_hover_v13_5.png Binary files differnew file mode 100644 index 00000000000..e6c85bd39e4 --- /dev/null +++ b/doc/ci/yaml/img/ci_config_visualization_hover_v13_5.png diff --git a/doc/ci/yaml/img/ci_config_visualization_v13_5.png b/doc/ci/yaml/img/ci_config_visualization_v13_5.png Binary files differnew file mode 100644 index 00000000000..0aee5cff7be --- /dev/null +++ b/doc/ci/yaml/img/ci_config_visualization_v13_5.png diff --git a/doc/ci/yaml/includes.md b/doc/ci/yaml/includes.md index f7ed7248dc4..d7945617dc9 100644 --- a/doc/ci/yaml/includes.md +++ b/doc/ci/yaml/includes.md @@ -73,10 +73,11 @@ automatically fetched and evaluated along with the content of `.gitlab-ci.yml`. Content of `https://gitlab.com/awesome-project/raw/master/.before-script-template.yml`: ```yaml -before_script: - - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs - - gem install bundler --no-document - - bundle install --jobs $(nproc) "${FLAGS[@]}" +default: + before_script: + - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs + - gem install bundler --no-document + - bundle install --jobs $(nproc) "${FLAGS[@]}" ``` Content of `.gitlab-ci.yml`: diff --git a/doc/ci/yaml/visualization.md b/doc/ci/yaml/visualization.md new file mode 100644 index 00000000000..ac5f5c8fd14 --- /dev/null +++ b/doc/ci/yaml/visualization.md @@ -0,0 +1,46 @@ +# Visualize your CI/CD configuration + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241722) in GitLab 13.5. +> - It's [deployed behind a feature flag](../../user/feature_flags.md), disabled by default. +> - It's disabled on GitLab.com. +> - It's not recommended for production use. +> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-cicd-configuration-visualization). **(CORE ONLY)** + +CAUTION: **Warning:** +This feature might not be available to you. Check the **version history** note above for details. + +To see a visualization of your `gitlab-ci.yml` configuration, navigate to any CI/CD +configuration file and click on the `Visualization` tab. The visualization shows +all stages and jobs. [`needs`](README.md#needs) relationships are displayed as lines +connecting jobs together, showing the hierarchy of execution: + + + +Hovering on a job highlights its `needs` relationships: + + + +If the configuration does not have any `needs` relationships, then no lines are drawn because +each job depends only on the previous stage being completed successfully. + +You can only preview one `gitlab-ci.yml` file at a time. Configuration imported with +[`includes`](README.md#include) is ignored and not included in the visualization. + +## Enable or disable CI/CD configuration visualization **(CORE ONLY)** + +CI/CD configuration visualization is under development and not ready for production use. It is +deployed behind a feature flag that is **disabled by default**. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can enable it. + +To enable it: + +```ruby +Feature.enable(:gitlab_ci_yml_preview) +``` + +To disable it: + +```ruby +Feature.disable(:gitlab_ci_yml_preview) +``` |
