How to use if-else condition on gitlabci

Question

How to use if else condition inside the gitlab-CI.

I have below code:

deploy-dev:
  image: testimage
  environment: dev
  tags:
    - kubectl
  script:
   - kubectl apply -f demo1 --record=true
   - kubectl apply -f demo2 --record=true

Now I want to add a condition something like this

script:
    - (if [ "$flag" == "true" ]; then kubectl apply -f demo1 --record=true; else kubectl apply -f demo2 --record=true);

Could someone provide the correct syntax for the same? Is there any documentation for the conditions (if-else, for loop) in gitlabci?

Why did you put brackets around the `if` line? – Izydorr Feb 22 '19 at 08:25 — Izydorr, Feb 22 '19 at 08:25

score 284 · Accepted Answer · edited Sep 29 '21 at 05:12

284

Hereunder three syntax options for that kind of statement. From gitlab-ci documentation :

Using shell variable

deploy-dev:
image: testimage
environment: dev
tags:
 - kubectl
script:
 - if [ "$flag" == "true" ]; then MODULE="demo1"; else MODULE="demo2"; fi
 - kubectl apply -f ${MODULE} --record=true

Using shell variable with yaml multiline block

deploy-dev:
image: testimage
environment: dev
tags:
  - kubectl
script:
  - >
    if [ "$flag" == "true" ]; then
      kubectl apply -f demo1 --record=true
    else
      kubectl apply -f demo2 --record=true
    fi

Using gitlab rules

workflow:
  rules:
    - if: '$CI_PIPELINE_SOURCE == "schedule"'
      when: never
    - if: '$CI_PIPELINE_SOURCE == "push"'
      when: never
    - when: always

Using gitlab templates and variables

demo1-deploy-dev:
  extends: .deploy-dev
  only:
    variables: [ $flag == "true" ]
  variables:
    MODULE: demo1
        
demo2-deploy-dev:
  extends: .deploy-dev
  only:
    variables: [ $flag == "false" ]
  variables:
    MODULE: demo2
        
.deploy-dev:
image: testimage
environment: dev
tags:
  - kubectl
script:
  - kubectl apply -f ${MODULE} --record=true

edited Sep 29 '21 at 05:12

Blue

22,608
7
62
92

answered Apr 01 '19 at 21:52

Xavier D

3,364
1
9
16

In the last example how you check the value of $flag? – Roger Coll Sep 18 '19 at 10:25
@RogerCollAumatell : i.e. Using `only: variables: [ $flag == "true" ]` – Xavier D Sep 26 '19 at 07:24
1

@XavierD: I'm not able to grok the last example. It looks like a variable is being set for MODULE, which is used in .deploy-dev, which is based on $flag, but what causes .deploy-dev to be run at all? (I thought the '.' prefix meant that the section was skipped (hidden)? – Cognitiaclaeves Nov 01 '19 at 17:11
1

Thanks @Cognitiaclaeves. Indeed `extends` keyword was missing from jobs definitions. You're right, the '.' prefixed job is not executed and acts as a template or let's say an abstract job here. I've fixed my example. Hope it's more clear now. – Xavier D Nov 02 '19 at 00:11
5

there is also `- |` which is similar to `- >` only that it will keep the content multiline instead of concatenating it into a single line interspersed with `;` – fabb Feb 02 '21 at 10:22

score 37 · Answer 2 · edited Oct 25 '21 at 12:50

Note that with GitLab 13.3 (August 2020), there is an improvement to the if-else rule syntax:

CI/CD rules:if support logical expressions with parentheses

If you use the rules keyword with if clauses, it’s now even more powerful, with support for bracketed expressions evaluated by the pipeline processor.

You can use more complex and efficient AND (&&) / OR (||) expressions, making your pipelines rules more logical, powerful, and easier to manage.

See Documentation and Issue.

And, with GitLab 13.8 (January 2021)

Support variables for pipeline rules

Previously, the rules keyword was limited in scope and only determined if a job should be included or excluded from pipelines. In this release, you can now decide if certain conditions are met and subsequently override variables in jobs, providing you with more flexibility when configuring your pipelines.

See Documentation and Issue.

With GitLab 13.12 (May 2021):

Support variables in CI/CD pipeline 'workflow:rules'

Previously, the rules keyword was limited in scope and only determined if a job should be included or excluded from pipelines. In 13.8, we added the ability to use the variables keyword with rules to set variable values in a job based on which rule matched.

In this release we’ve extended this ability to workflow: rules, so you can set variable values for the whole pipeline if certain conditions match.
This helps you make your pipelines even more flexible.

See Documentation and Issue.

score 8 · Answer 3 · answered Jul 16 '20 at 10:27

In addition, in the case of a multiline block if you want or need to preserve line breaks you can use the pipe character:

script: |
    if [ "$flag" == "true" ]; then
      kubectl apply -f demo1 --record=true
    else
      kubectl apply -f demo2 --record=true
    fi

To go deeper, visit https://yaml-multiline.info/

score 5 · Answer 4 · answered Feb 19 '19 at 09:54

5

I think you need to just add a semicolon and closing "fi" at the end. I couldn't find a link to documentation.

script:
    - (if [ "$flag" == "true" ]; then kubectl apply -f demo1 --record=true; else kubectl apply -f demo2 --record=true; fi);

answered Feb 19 '19 at 09:54

Amina Mansour

131
5

score 4 · Answer 5 · answered Mar 12 '20 at 03:39

4

You may consider checking rules

It allows for a list of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.

Available rule clauses include:

if (similar to only:variables)
changes (same as only:changes)
exists

Example:

job:
  script: "echo Hello, Rules!"
  rules:
    - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "master"'
      when: always
    - if: '$VAR =~ /pattern/'
      when: manual
    - when: on_success

answered Mar 12 '20 at 03:39

Arihant Godha

2,339
2
26
50

Using =~ pattern matching is really useful. Just be aware of the limitations of this regex pattern matching if you decide to use the pattern in a variable: https://gitlab.com/gitlab-org/gitlab/-/issues/35438 – Christian Groleau Jan 14 '21 at 19:21

score 0 · Answer 6 · answered Jan 19 '22 at 21:37

0

This worked for me when using powershell based gitlab scripts:

script:
  - 'if ($flag -eq "true") { kubectl apply -f demo1 --record=true; } else { kubectl apply -f demo2 --record=true; }'

answered Jan 19 '22 at 21:37

Eternal21

4,190
2
48
63

How to use if-else condition on gitlabci

6 Answers6

Using shell variable

Using shell variable with yaml multiline block

Using gitlab rules

Using gitlab templates and variables

CI/CD rules:if support logical expressions with parentheses

Support variables for pipeline rules

Support variables in CI/CD pipeline 'workflow:rules'

Linked