Choose when to run jobs (FREE)

When a new pipeline starts, GitLab checks the pipeline configuration to determine which jobs should run in that pipeline. You can configure jobs to run depending on the status of variables, the pipeline type, and so on.

To configure a job to be included or excluded from certain pipelines, you can use:

Use needs to configure a job to run as soon as the earlier jobs it depends on finish running.

Specify when jobs run with `rules`

Introduced in GitLab 12.3.

Use rules to include or exclude jobs in pipelines.

Rules are evaluated in order until the first match. When a match is found, the job is either included or excluded from the pipeline, depending on the configuration. See the rules reference for more details.

Future keyword improvements are being discussed in our epic for improving rules, where anyone can add suggestions or requests.

`rules` examples

The following example uses if to define that the job runs in only two specific cases:

job:
  script: echo "Hello, Rules!"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
      when: manual
      allow_failure: true
    - if: '$CI_PIPELINE_SOURCE == "schedule"'

If the pipeline is for a merge request, the first rule matches, and the job is added to the merge request pipeline with attributes of:
- when: manual (manual job)
- allow_failure: true (the pipeline continues running even if the manual job is not run)
If the pipeline is not for a merge request, the first rule doesn't match, and the second rule is evaluated.
If the pipeline is a scheduled pipeline, the second rule matches, and the job is added to the scheduled pipeline. No attributes were defined, so it is added with:
- when: on_success (default)
- allow_failure: false (default)
In all other cases, no rules match, so the job is not added to any other pipeline.

Alternatively, you can define a set of rules to exclude jobs in a few cases, but run them in all other cases:

job:
  script: echo "Hello, Rules!"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
      when: never
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
      when: never
    - when: on_success

If the pipeline is for a merge request, the job is not added to the pipeline.
If the pipeline is a scheduled pipeline, the job is not added to the pipeline.
In all other cases, the job is added to the pipeline, with when: on_success.

WARNING: If you use a when: clause as the final rule (not including when: never), two simultaneous pipelines may start. Both push pipelines and merge request pipelines can be triggered by the same event (a push to the source branch for an open merge request). See how to prevent duplicate pipelines for more details.

Complex rules

You can use all rules keywords, like if, changes, and exists, in the same rule. The rule evaluates to true only when all included keywords evaluate to true.

For example:

docker build:
  script: docker build -t my-image:$CI_COMMIT_REF_SLUG .
  rules:
    - if: '$VAR == "string value"'
      changes:  # Include the job and set to when:manual if any of the follow paths match a modified file.
        - Dockerfile
        - docker/scripts/*
      when: manual
      allow_failure: true

If the Dockerfile file or any file in /docker/scripts has changed and $VAR == "string value", then the job runs manually and is allowed to fail.

You can use parentheses with && and || to build more complicated variable expressions. Introduced in GitLab 13.3:

job1:
  script:
    - echo This rule uses parentheses.
  rules:
    if: ($CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH == "develop") && $MY_VARIABLE

WARNING: Before GitLab 13.3, rules that use both || and && may evaluate with an unexpected order of operations.

Avoid duplicate pipelines

If a job uses rules, a single action, like pushing a commit to a branch, can trigger multiple pipelines. You don't have to explicitly configure rules for multiple types of pipeline to trigger them accidentally.

Some configurations that have the potential to cause duplicate pipelines cause a pipeline warning to be displayed. Introduced in GitLab 13.3.

For example:

job:
  script: echo "This job creates double pipelines!"
  rules:
    - if: '$CUSTOM_VARIABLE == "false"'
      when: never
    - when: always

This job does not run when $CUSTOM_VARIABLE is false, but it does run in all other pipelines, including both push (branch) and merge request pipelines. With this configuration, every push to an open merge request's source branch causes duplicated pipelines.

To avoid duplicate pipelines, you can:

Use workflow to specify which types of pipelines can run.

Rewrite the rules to run the job only in very specific cases, and avoid a final when: rule:

job:
  script: echo "This job does NOT create double pipelines!"
  rules:
    - if: '$CUSTOM_VARIABLE == "true" && $CI_PIPELINE_SOURCE == "merge_request_event"'

You can also avoid duplicate pipelines by changing the job rules to avoid either push (branch) pipelines or merge request pipelines. However, if you use a - when: always rule without workflow: rules, GitLab still displays a pipeline warning.

For example, the following does not trigger double pipelines, but is not recommended without workflow: rules:

job:
  script: echo "This job does NOT create double pipelines!"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "push"'
      when: never
    - when: always

You should not include both push and merge request pipelines in the same job without workflow:rules that prevent duplicate pipelines:

job:
  script: echo "This job creates double pipelines!"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "push"'
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'

Also, do not mix only/except jobs with rules jobs in the same pipeline. It may not cause YAML errors, but the different default behaviors of only/except and rules can cause issues that are difficult to troubleshoot:

job-with-no-rules:
  script: echo "This job runs in branch pipelines."

job-with-rules:
  script: echo "This job runs in merge request pipelines."
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'

For every change pushed to the branch, duplicate pipelines run. One branch pipeline runs a single job (job-with-no-rules), and one merge request pipeline runs the other job (job-with-rules). Jobs with no rules default to except: merge_requests, so job-with-no-rules runs in all cases except merge requests.

Common `if` clauses for `rules`

For behavior similar to the only/except keywords, you can check the value of the $CI_PIPELINE_SOURCE variable:

Value	Description
`api`	For pipelines triggered by the pipelines API.
`chat`	For pipelines created by using a GitLab ChatOps command.
`external`	When you use CI services other than GitLab.
`external_pull_request_event`	When an external pull request on GitHub is created or updated. See Pipelines for external pull requests.
`merge_request_event`	For pipelines created when a merge request is created or updated. Required to enable merge request pipelines, merged results pipelines, and merge trains.
`parent_pipeline`	For pipelines triggered by a parent/child pipeline with `rules`. Use this pipeline source in the child pipeline configuration so that it can be triggered by the parent pipeline.
`pipeline`	For multi-project pipelines created by using the API with `CI_JOB_TOKEN`, or the `trigger` keyword.
`push`	For pipelines triggered by a `git push` event, including for branches and tags.
`schedule`	For scheduled pipelines.
`trigger`	For pipelines created by using a trigger token.
`web`	For pipelines created by using Run pipeline button in the GitLab UI, from the project's CI/CD > Pipelines section.
`webide`	For pipelines created by using the WebIDE.

The following example runs the job as a manual job in scheduled pipelines or in push pipelines (to branches or tags), with when: on_success (default). It does not add the job to any other pipeline type.

job:
  script: echo "Hello, Rules!"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
      when: manual
      allow_failure: true
    - if: '$CI_PIPELINE_SOURCE == "push"'

The following example runs the job as a when: on_success job in merge request pipelines and scheduled pipelines. It does not run in any other pipeline type.

job:
  script: echo "Hello, Rules!"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    - if: '$CI_PIPELINE_SOURCE == "schedule"'

Other commonly used variables for if clauses:

if: $CI_COMMIT_TAG: If changes are pushed for a tag.
if: $CI_COMMIT_BRANCH: If changes are pushed to any branch.
if: '$CI_COMMIT_BRANCH == "main"': If changes are pushed to main.
if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH': If changes are pushed to the default branch. Use when you want to have the same configuration in multiple projects with different default branches.
if: '$CI_COMMIT_BRANCH =~ /regex-expression/': If the commit branch matches a regular expression.
if: '$CUSTOM_VARIABLE !~ /regex-expression/': If the custom variable CUSTOM_VARIABLE does not match a regular expression.
if: '$CUSTOM_VARIABLE == "value1"': If the custom variable CUSTOM_VARIABLE is exactly value1.

Variables in `rules:changes`

Introduced in GitLab 13.6.

Feature flag removed in GitLab 13.7.

You can use CI/CD variables in rules:changes expressions to determine when to add jobs to a pipeline:

docker build:
  variables:
    DOCKERFILES_DIR: 'path/to/files/'
  script: docker build -t my-image:$CI_COMMIT_REF_SLUG .
  rules:
    - changes:
        - $DOCKERFILES_DIR/*

You can use the $ character for both variables and paths. For example, if the $DOCKERFILES_DIR variable exists, its value is used. If it does not exist, the $ is interpreted as being part of a path.

Specify when jobs run with `only` and `except`

You can use only and except to control when to add jobs to pipelines.

Use only to define when a job runs.
Use except to define when a job does not run.

`only:refs` / `except:refs` examples

only or except used without refs is the same as only:refs / except/refs

In the following example, job runs only for:

job:
  # use special keywords
  only:
    - tags
    - triggers
    - schedules

To execute jobs only for the parent repository and not forks:

job:
  only:
    - branches@gitlab-org/gitlab
  except:
    - main@gitlab-org/gitlab
    - /^release/.*$/@gitlab-org/gitlab

This example runs job for all branches on gitlab-org/gitlab, except main and branches that start with release/.

`only: variables` / `except: variables` examples

You can use except:variables to exclude jobs based on a commit message:

end-to-end:
  script: rake test:end-to-end
  except:
    variables:
      - $CI_COMMIT_MESSAGE =~ /skip-end-to-end-tests/

You can use parentheses with && and || to build more complicated variable expressions:

job1:
  script:
    - echo This rule uses parentheses.
  only:
    variables:
      - ($CI_COMMIT_BRANCH == "main" || $CI_COMMIT_BRANCH == "develop") && $MY_VARIABLE

When multiple entries are specified in only:variables, the job runs when at least one of them evaluates to true. You can use && in a single entry when multiple conditions must be satisfied at the same time.

`only:changes` / `except:changes` examples

You can skip a job if a change is detected in any file with a .md extension in the root directory of the repository:

build:
  script: npm run build
  except:
    changes:
      - "*.md"

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.

Read more about how to use only:changes and except:changes:

New branches or tags without pipelines for merge requests.
Scheduled pipelines.

Use `only:changes` with pipelines for merge requests

With pipelines for merge requests, it's possible to define a job to be created based on files modified in a merge request.

Use this keyword with only: [merge_requests] so GitLab can find the correct base SHA of the source branch. File differences are correctly calculated from any further commits, and all changes in the merge requests are properly tested in pipelines.

For example:

docker build service one:
  script: docker build -t my-service-one-image:$CI_COMMIT_REF_SLUG .
  only:
    refs:
      - merge_requests
    changes:
      - Dockerfile
      - service-one/**/*

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:

docker build service one:
  script: docker build -t my-service-one-image:$CI_COMMIT_REF_SLUG .
  only:
    changes:
      - Dockerfile
      - service-one/**/*

In this example, 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.

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.

Use `only:changes` without pipelines for merge requests

Without pipelines for merge requests, pipelines run on branches or tags that don't have an explicit association with a merge request. In this case, a previous SHA is used to calculate the diff, which is equivalent to git diff HEAD~. This can result in some unexpected behavior, including:

When pushing a new branch or a new tag to GitLab, the policy always evaluates to true.
When pushing a new commit, the changed files are calculated by using the previous commit as the base SHA.

Use `only:changes` with scheduled pipelines

only:changes always evaluates as true in Scheduled pipelines. All files are considered to have changed when a scheduled pipeline runs.

Combine multiple keywords with `only` or `except`

If you use multiple keywords with only or except, the keywords 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.
except: excludes the job if any of the keys have at least one condition that matches.

With only, individual keys are logically joined by an AND. A job is added to 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 following example, the test job is only created when all of the following are true:

The pipeline is scheduled or runs for main.
The variables keyword matches.
The kubernetes service is active on the project.

test:
  script: npm run test
  only:
    refs:
      - main
      - schedules
    variables:
      - $CI_COMMIT_MESSAGE =~ /run-end-to-end-tests/
    kubernetes: active

With except, individual keys are logically joined by an OR. A job is not 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 following example, the test job is not created when any of the following are true:

The pipeline runs for the main branch.
There are changes to the README.md file in the root directory of the repository.

test:
  script: npm run test
  except:
    refs:
      - main
    changes:
      - "README.md"

Use predefined CI/CD variables to run jobs only in specific pipeline types

You can use predefined CI/CD variables to choose which pipeline types jobs run in, with:

The following table lists some of the variables that you can use, and the pipeline types the variables can control for:

Branch pipelines that run for Git push events to a branch, like new commits or tags.
Tag pipelines that run only when a new Git tag is pushed to a branch.
Merge request pipelines that run for changes to a merge request, like new commits or selecting the Run pipeline button in a merge request's pipelines tab.
Scheduled pipelines.

Variables	Branch	Tag	Merge request	Scheduled
`CI_COMMIT_BRANCH`	Yes			Yes
`CI_COMMIT_TAG`		Yes		Yes, if the scheduled pipeline is configured to run on a tag.
`CI_PIPELINE_SOURCE = push`	Yes	Yes
`CI_PIPELINE_SOURCE = scheduled`				Yes
`CI_PIPELINE_SOURCE = merge_request_event`			Yes
`CI_MERGE_REQUEST_IID`			Yes

For example, to configure a job to run for merge request pipelines and scheduled pipelines, but not branch or tag pipelines:

job1:
  script:
    - echo
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    - if: $CI_PIPELINE_SOURCE == "scheduled"
    - if: $CI_PIPELINE_SOURCE == "push"
      when: never

Regular expressions

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.

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 /. Pattern matching is case-sensitive by default. Use the i flag modifier, like /pattern/i, to make a pattern case-insensitive:

job:
  # use regexp
  only:
    - /^issue-.*$/i
  # use special keyword
  except:
    - branches

Use anchors ^ and $ to avoid the regular expression matching only a substring of the tag name or branch name. For example, /^issue-.*$/ is equivalent to /^issue-/, while just /issue/ would also match a branch called severe-issues.

`only` / `except` regex syntax

In GitLab 11.9.4, GitLab began internally converting the regexp used in only and except keywords to RE2.

RE2 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 are now supported.

From GitLab 11.9.7 to GitLab 12.0, GitLab provided a feature flag to let you use unsafe regexp syntax. After migrating to safe syntax, you should disable this feature flag again:

Feature.enable(:allow_unsafe_ruby_regexp)

CI/CD variable expressions

Introduced in GitLab 10.7 for the only and except CI keywords

Expanded in GitLab 12.3 with the rules keyword

Use variable expressions to control which jobs are created in a pipeline after changes are pushed to GitLab. You can use variable expressions with:

For example, with rules:if:

job1:
  variables:
    VAR1: "variable1"
  script:
    - echo "Test variable comparison
  rules:
    - if: $VAR1 == "variable1"

Compare a variable to a string

You can use the equality operators == and != to compare a variable with a string. Both single quotes and double quotes are valid. The order doesn't matter, so the variable can be first, or the string can be first. For example:

if: $VARIABLE == "some value"
if: $VARIABLE != "some value"
if: "some value" == $VARIABLE

Compare two variables

You can compare the values of two variables. For example:

if: $VARIABLE_1 == $VARIABLE_2
if: $VARIABLE_1 != $VARIABLE_2

Check if a variable is undefined

You can compare a variable to the null keyword to see if it is defined. For example:

if: $VARIABLE == null
if: $VARIABLE != null

Check if a variable is empty

You can check if a variable is defined but empty. For example:

if: $VARIABLE == ""
if: $VARIABLE != ""

Check if a variable exists

You can check for the existence of a variable by using just the variable name in the expression. The variable must not be empty. For example:

if: $VARIABLE

Compare a variable to a regex pattern

You can do regex pattern matching on variable values with the =~ and !~ operators. Variable pattern matching with regular expressions uses the RE2 regular expression syntax.

Expressions evaluate as true if:

Matches are found when using =~.
Matches are not found when using !~.

For example:

$VARIABLE =~ /^content.*/
$VARIABLE_1 !~ /^content.*/

Pattern matching is case-sensitive by default. Use the i flag modifier to make a pattern case-insensitive. For example: /pattern/i.

Join variable expressions together with `&&` or `||`

Introduced in GitLab 12.0

You can join multiple expressions using && (and) or || (or), for example:

$VARIABLE1 =~ /^content.*/ && $VARIABLE2 == "something"
$VARIABLE1 =~ /^content.*/ && $VARIABLE2 =~ /thing$/ && $VARIABLE3
$VARIABLE1 =~ /^content.*/ || $VARIABLE2 =~ /thing$/ && $VARIABLE3

The precedence of operators follows the Ruby 2.5 standard, so && is evaluated before ||.

Group variable expressions together with parentheses

Introduced in GitLab 13.3.

Feature flag removed in GitLab 13.5.

You can use parentheses to group expressions together. Parentheses take precedence over && and ||, so expressions enclosed in parentheses are evaluated first, and the result is used for the rest of the expression.

You can nest parentheses to create complex conditions, and the inner-most expressions in parentheses are evaluated first.

For example:

($VARIABLE1 =~ /^content.*/ || $VARIABLE2) && ($VARIABLE3 =~ /thing$/ || $VARIABLE4)
($VARIABLE1 =~ /^content.*/ || $VARIABLE2 =~ /thing$/) && $VARIABLE3
$CI_COMMIT_BRANCH == "my-branch" || (($VARIABLE1 == "thing" || $VARIABLE2 == "thing") && $VARIABLE3)

Choose when to run jobs (FREE)

Specify when jobs run with rules

rules examples

Complex rules

Avoid duplicate pipelines

Common if clauses for rules

Variables in rules:changes

Specify when jobs run with only and except

only:refs / except:refs examples

only: variables / except: variables examples

only:changes / except:changes examples

Use only:changes with pipelines for merge requests

Use only:changes without pipelines for merge requests

Use only:changes with scheduled pipelines

Combine multiple keywords with only or except

Use predefined CI/CD variables to run jobs only in specific pipeline types

Regular expressions

only / except regex syntax

CI/CD variable expressions

Compare a variable to a string

Compare two variables

Check if a variable is undefined

Check if a variable is empty

Check if a variable exists

Compare a variable to a regex pattern

Join variable expressions together with && or ||

Group variable expressions together with parentheses

Specify when jobs run with `rules`

`rules` examples

Common `if` clauses for `rules`

Variables in `rules:changes`

Specify when jobs run with `only` and `except`

`only:refs` / `except:refs` examples

`only: variables` / `except: variables` examples

`only:changes` / `except:changes` examples

Use `only:changes` with pipelines for merge requests

Use `only:changes` without pipelines for merge requests

Use `only:changes` with scheduled pipelines

Combine multiple keywords with `only` or `except`

`only` / `except` regex syntax

Join variable expressions together with `&&` or `||`