How to run job on a specific branch using rules in GitLab CI/CD

Created Jun 9, 2020 Edited Jun 9, 2020

Viewed 13234

It seems rules replaces only/except functionality in the latests GitLab versions.

Before, specifying that a job had to be executed only for master branch, for example, was very straightforward.

How would that be done with rules?

I'm guessing GitLab provides some variable that specifies the current branch's name, but I cannot find that. The only examples I see are regarding merge requests.

In other words, if I have the following job, how to restrict it to run only in potato branch?

unit_tests:
  stage: test
  script: dotnet vstest test/*UnitTests/bin/Release/**/*UnitTests.dll --Blame
  rules:
    - exists:
      - test/*UnitTests/*UnitTests.csproj

gitlab-ci

2 Answers

I guess this would be it:

unit_tests:
  stage: test
  script: dotnet vstest test/*UnitTests/bin/Release/**/*UnitTests.dll --Blame
  rules:
    - if: $CI_COMMIT_BRANCH == "potato"

edited Mar 25, 2021

user_8971700

answered Mar 25, 2021

Here are the variable references:

https://docs.gitlab.com/ee/ci/variables/predefined_variables.html

Here is an example from gitlab-runner project source code itself

https://gitlab.com/gitlab-org/gitlab-runner/-/blob/main/.gitlab/ci/test.gitlab-ci.yml

job-name: 
  script:
    - echo "i am potato"
  rules:
    - if: '$CI_COMMIT_BRANCH == "potato"'

edited Jun 9, 2020

user_12591850

answered Jun 9, 2020