Create environment variable from parameters in Jenkins

Question

I have a jenkinsfile which is parametrized. Based on the input parameters I want to set certain environment variables. But I m not able to get the syntax right.

parameters {
    choice choices: ['insure-base-docker/insure-base', 'insure-ide/insure-sd', 'insure-ide/insure-ansible','insure-ide/ansible-test-vini'], description: 'Auf welche repository sollte die Tag erstellt?', name: 'repository'
    choice choices: ['tag', 'branch'], description: 'Tag oder branch erstellen', name: 'git_entity'
    string defaultValue: '21.x.x', description: 'Version die als branch oder Tag ersellt werden muss', name: 'version', trim: false
}
environment {
    GIT_URL = "${'https://my_repo/scm/'+param.repository+'.git'}"
    GIT_BRANCH = "${'Release/'+param.version}"
    CHECKOUT_BRANCH = '${${git_entity} == "tag" ? "master" : "develop"}'      
}

the env vars are always wrong. How do I set the env vars correctly?

You have a typo in your environment directive: the object is params and not param. — Matthew Schuchard
– Matthew Schuchard, Commented Mar 30, 2021 at 16:41

Stefano Martins · Accepted Answer · 2021-04-10 19:45:02Z

3

Nowadays, there aren't many differences between parameters and environment variables in Jenkins. Even the way you use them, preceded by the env. keyword, is the same.

Try something like this.

pipeline {
    parameters {
      choice choices: ['insure-base-docker/insure-base', 'insure-ide/insure-sd', 'insure-ide/insure-ansible','insure-ide/ansible-test-vini'], description: 'Auf welche repository sollte die Tag erstellt?', name: 'GIT_PROJECT'
      string defaultValue: '21.x.x', description: 'Version die als branch oder Tag ersellt werden muss', name: 'GIT_BRANCH', trim: false
    }

    agent any

    stages {
        stage('Cloning Git repository') {
            steps {
                script {
                    git branch: "${env.GIT_BRANCH}", credentialsId: 'MY_GIT_CREDENTIALS_PREVIOUSLY_ADDED_TO_JENKINS', url: "http://github.com/user/${env.GIT_PROJECT}.git"
                }
            }
        }
    }
}

You can use as GIT_BRANCH not just branches, but also tags.

Best regards.

edited Apr 10, 2021 at 19:45

answered Mar 31, 2021 at 4:55

Stefano Martins

4922 silver badges7 bronze badges

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

4 Comments

Vini Over a year ago

Do you see in the env section in the code, i have env variables as a string in conjunction to the params

Vini Over a year ago

and also the above doesnt work with variables. I have an echo which prints the value, its right from my env, but the usage of git with vars isnt working

Vini Over a year ago

error: > git config --get remote.${GIT_URL_STEP}.url # timeout=10 ERROR: Error fetching remote repo 'origin' hudson.plugins.git.GitException: Failed to fetch from ${GIT_URL_STEP}

Vini Over a year ago

the double quotes was important

Fred · Accepted Answer · 2023-06-19 14:50:25Z

I had to map the param to env in the stage:

pipeline {
    parameters {
      choice choices: ['insure-base-docker/insure-base', 'insure-ide/insure-sd', 'insure-ide/insure-ansible','insure-ide/ansible-test-vini'], description: 'Auf welche repository sollte die Tag erstellt?', name: 'GIT_PROJECT'
      string defaultValue: '21.x.x', description: 'Version die als branch oder Tag ersellt werden muss', name: 'GIT_BRANCH', trim: false
    }

    stages {
        stage('Cloning Git repository') {
            environment {
                GIT_PROJECT = "${params.GIT_PROJECT}"
                GIT_BRANCH = "${params.GIT_BRANCH}"
            }
        }
    }
}

Now I can access the parameters as environment variables in other scripts that can only use environment variables.

vijaydeep · Accepted Answer · 2021-03-30 17:27:36Z

I am assuming you are using a freestyle project here are the steps

Go to Build Environment part and check the option Inject environment variables to the build process it will open a new set of input boxes.
enter your code in Groovy script

Here am just trying to update the Version and Full version to include the passing parameter say TestParam

here is a sample:


import hudson.model.*
import groovy.io.FileType

def build = Thread.currentThread().executable
def buildNumber = build.number
def workspace = build.getEnvVars()["WORKSPACE"]
def defaultBuildNo = build.getEnvVars()["BUILD_NUMBER"]
println "Hi from Groovy script "
println workspace
println defaultBuildNo

def map = [
                 "BUILD_NUMBER": defaultBuildNo,
                 "VERSION" : defaultBuildNo + build.getEnvVars()["TestParam"],
                 "FULL_VERSION": +defaultBuildNo + "." + build.getEnvVars(["TestParam"]
                ]
return map

Now in the execute shell part type these and see all will resolve successfully.

Execute shell

 echo $TestParam
 echo $BUILD_NUMBER
 echo $VERSION
 echo $FULL_VERSION

Now all these env variables are accessible throughout the Job.

Collectives™ on Stack Overflow

Create environment variable from parameters in Jenkins

3 Answers 3

4 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

4 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related