Pass build inputs from Jenkins to a Python script

Question

I wrote this simple Jenkinsfile to execute a Python script.

The Jenkins job is supposed to take the value of the Jenkins build parameter and inject it to the python script, then execute the python script.

Here is the Jenkinsfile

pipeline{
agent any
parameters {
    string description: 'write the week number', name: 'Week_Number'
}
stages{
    stage("Pass Week Number&execute script"){
        steps{
            sh 'python3 statistics.py'
        }
    }
}
}

So what will happen is that I will go to Jenkins, choose build with parameters, and write some value in the Week_Number variable.

What i need to do is: Pass this Week_Number value as an integer to a variable in the python script.

This is the part of the Python script that I'm interested in:

  weekNum = int(os.environ.get("Week_Number"))

I read online about the use of os.environ.get() to pass values, but I think something is still missing for the Python script to fetch the Jenkins build parameter.

Any help?

Siddharth Kaul · Accepted Answer · 2022-11-27 21:39:57Z

2

You need your python script to be able to parse command line arguments or named command line arguments.

If your script is using command line argument you can pass parameters as follow:

stages{
    stage("Pass Week Number&execute script"){
        steps{
            sh('python3 statistics.py ' + params.Week_Number)
        }
    }
}

If your script uses the named command line argument where the named argument in the script is input_week_number you can pass as follows:

stages{
    stage("Pass Week Number&execute script"){
        steps{
            sh('python3 statistics.py --input_week_number' + params.Week_Number)
        }
    }
}

answered Nov 27, 2022 at 21:39

Siddharth Kaul

1,05013 silver badges24 bronze badges

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

Collectives™ on Stack Overflow

Pass build inputs from Jenkins to a Python script

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related