Gitlab: Make required variables when running pipeline

Question

I want the some of the variables should be required before executing the pipeline in gitlab. Can I achieve it. I have below gitlab-ci.yml

stages:          # Runs First - Anything that needs to run prior to your scripts running
  - deploy
  - Script

variables:
  Domain:
    value: "dom"
  HOST_NAME:
    value: ""  
  JAVA_FILES_WITH_ARGS:
    value: ""

I want to make mandatory(JAVA_FILES_WITH_ARGS, HOST_NAME) before run the pipeline how can I achieve it. it will not start the pipeline without these two variable values.

stackoverflow.com/questions/69674002/… might be the right approach — Simon Schrottner
– Simon Schrottner, Commented Oct 27, 2021 at 8:00
Simon how to give custom error mesage instead "No stages and Pipeline" when it allow not to proceed — Rajarshi Das
– Rajarshi Das, Commented Oct 27, 2021 at 9:46

Dennis · Accepted Answer · 2022-11-16 09:28:16Z

4

The Answer: is

rules:
 - if: '$JAVA_FILES_WITH_ARGS != "" && $HOST_NAME != ""'
   allow_failure: true

edited Nov 16, 2022 at 9:28

Dennis

20.6k5 gold badges68 silver badges83 bronze badges

answered Oct 27, 2021 at 9:48

Rajarshi Das

12.4k7 gold badges53 silver badges88 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Dennis Over a year ago

@Kappacake i've made the suggested edits

SRG Over a year ago

Further reference: docs.gitlab.com/ee/ci/jobs/job_rules.html

Cloudkollektiv · Accepted Answer · 2024-12-23 00:23:32Z

I usually prefer to do input validation in a before_script. If you use rules in a job, the job won't be shown in the GUI when a rule evaluates to false. Using a before_script offers a more flexible approach, because you can do much more than checking for empty strings.

stages:
  - deploy
  - Script

variables:
  DOMAIN: "dom"
  HOST_NAME: ""
  JAVA_FILES_WITH_ARGS: ""
  FILE_PATH: "/tmp/file.txt"
  TXT_RED: "\e[91m"
  TXT_CLEAR: "\e[0m"

.validate-input: &validate-input
  - |
    # Pipeline input validation
    if [ -z "${HOST_NAME}" ]; then
      echo -e "${TXT_RED}HOST_NAME cannot be empty${TXT_CLEAR}"
      exit 1
    fi

    if [ -z "${JAVA_FILES_WITH_ARGS}" ]; then
      echo -e "${TXT_RED}JAVA_FILES_WITH_ARGS cannot be empty${TXT_CLEAR}"
      exit 1
    fi

    if [[ ! -f "${FILE_PATH}" ]]; then
      echo -e "${TXT_RED}FILE_PATH file not found${TXT_CLEAR}"
    fi

my_job:
  allow_failure: false
  before_script:
    - *validate-input
  script:
    echo -e "Hello World!"

Collectives™ on Stack Overflow

Gitlab: Make required variables when running pipeline

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related