Define and access a variable in multiple steps of a jenkins pipeline

Question

I came here from this post Defining a variable in shell script portion of Jenkins Pipeline

My situation is the following I have a pipeline that is updating some files and generating a PR in my repo if there are changes in the generated files (they change every couple of weeks or less).

At the end of my pipeline I have a post action to send the result by email to our teams connector.

I wanted to know if I could somehow generate a variable and include that variable in my email.

It looks something like this but off course it does not work.

#!groovy
String WasThereAnUpdate = '';

pipeline {
    agent any
    environment {
        GRADLE_OPTS = '-Dorg.gradle.java.home=$JAVA11_HOME'
    }
    stages {
        stage('File Update') {
            steps {
                sh './gradlew updateFiles -P updateEnabled'
            }
        }
        stage('Create PR') {
            steps {
                withCredentials(...) {
                    sh '''
                        if [ -n \"$(git status --porcelain)\" ]; then
                            WasThereAnUpdate=\"With Updates\"
                            ...
                        else
                            WasThereAnUpdate=\"Without updates\"
                        fi
                    '''
                }
            }    
        }
    }
    post {
        success {
            office365ConnectorSend(
                message: "Scheduler finished: " + WasThereAnUpdate,
                status: 'Success',
                color: '#1A5D1C',
                webhookUrl: 'https://outlook.office.com/webhook/1234'
            )
        }
    }
}

I've tried referencing my variable in different ways ${}, etc... but I'm pretty sure that assignment is not working. I know I probably could do it with a script block but I'm not sure how I would put the script block inside the SH itself, not sure this would be possible.

Thanks to the response from MaratC https://stackoverflow.com/a/64572833/5685482 and this documentation I'll do it something like this:

#!groovy
def date = new Date()
String newBranchName = 'protoUpdate_'+date.getTime()

pipeline {
    agent any
    stages {
        stage('ensure a diff') {
            steps {
                sh 'touch oneFile.txt'
            }
        }
        stage('AFTER') {
            steps {
                script {
                    env.STATUS2 = sh(script:'git status --porcelain', returnStdout: true).trim()
                }
            }
        }
    }
    post {
        success {
            office365ConnectorSend(
                message: "test ${env.STATUS2}",
                status: 'Success',
                color: '#1A5D1C',
                webhookUrl: 'https://outlook.office.com/webhook/1234'
            )
        }
}

score 5 · Accepted Answer · answered Oct 28 '20 at 12:26

5

In your code

sh '''
    if [ -n \"$(git status --porcelain)\" ]; then
        WasThereAnUpdate=\"With Updates\"
        ...
    else
        WasThereAnUpdate=\"Without updates\"
    fi
'''

Your code creates a sh session (most likely bash). That session inherits the environment variables from the process that started it (Jenkins). Once it runs git status, it then sets a bash variable WasThereAnUpdate (which is a different variable from likely named Groovy variable.)

This bash variable is what gets updated in your code.

Once your sh session ends, bash process gets destroyed, and all of its variables get destroyed too.

This whole process has no influence whatsoever on Groovy variable named WasThereAnUpdate that just stays what it was before.

answered Oct 28 '20 at 12:26

MaratC

6,418
2
20
27

yes that part is more or less what I was expecting, so there is no way of defining any kind of assignment in the SH section? even if I used an environment setting? – Miguel Costa Oct 28 '20 at 13:22
I'll try to look into this, see if I can store what I need in our environment setting https://e.printstacktrace.blog/jenkins-pipeline-environment-variables-the-definitive-guide/ – Miguel Costa Oct 28 '20 at 13:46
1

You can put your code in script that will print either `With Updates` or `Without Updates` and run `def UpdatesOutput = sh script: "myscript.sh", returnStdout: true`. Groovy variable named `UpdatesOutput` will then hold the output of the script. – MaratC Oct 28 '20 at 14:20

Define and access a variable in multiple steps of a jenkins pipeline

1 Answers1

Linked