I'm trying to pass environment variables to a custom post deploy plugin.
My Jenkins pipeline looks like this:
pipeline {
agent any
environment {
asdf = 'test'
}
stages {
stage("Env Variables") {
steps {
sh "printenv"
}
}
stage("Run Job") {
steps {
build 'test'
}
}
}
}
The Test job does 3 things:
Sets an environment variable qwer
Prins all environment variables
Runs a post deploy action from a custom plugin
What's happening:
The printenv command is showing the asdf variable.
The 'test' job is not showing the asdf variable, but it is showing the qwer variable.
The 'test' post deploy action is not seeing the asdf variable or the qwer variable.
How do I get the environment variable from the pipeline step to the build and post deploy action?
Related
I have Jenkins declarative file, and adding Jenkins plugin Environment Injector Plugin
I use Environment Injector Plugin to configure/inject environment variables, the problem is when i try to run printev to check available environment variable, nothing added to env variable
I use same plugin for Freestyle project and works fine. Can I use Environment Injector Plugin with pipeline or not possible at all?
I have try with echo $VAR_NAME and printev inside pipeline declaration and no luck
You don't have to rely on the environment inject plugin in a declarative Pipeline to set environment variables. You can use an environment block instead. Check here for details.
pipeline {
agent {
label '!windows'
}
environment {
DISABLE_AUTH = 'true'
DB_ENGINE = 'sqlite'
}
stages {
stage('Build') {
steps {
echo "Database engine is ${DB_ENGINE}"
echo "DISABLE_AUTH is ${DISABLE_AUTH}"
sh 'printenv'
}
}
}
}
How can I set a new environment variable from within a Jenkinsfile using declarative pipeline?
I know that I can read environment variables using env like this one for example ${env.JOB_NAME}.
But how can I set a new environment variable which can be be used by my build script for example. I want to do something like below. Is this the correct way?
stage("build_my_code") {
steps {
sh 'MY_ENV_VAR="some_value"'
sh './my_script.sh $MY_ENV_VAR'
}
}
You can use script step to run Groovy script in declarative pipeline,
Then in script step to set environment by env.xxx=yyy
stage("build_my_code") {
steps {
script {
// the MY_ENV_VAR environment variable should not exist,
// not allow to overwrite value of an existing environment variable.
env.MY_ENV_VAR="some_value"
}
sh './my_script.sh $MY_ENV_VAR'
}
}
I have a Jenkins setup where i want to configure the environment variable before building my pipeline.
I can set the environment variable in the configure page and use it in Jobs. However, I can not give the Administrator permission to the user to set it up. In-order to set the Environment variable user should have the admin access.
I have taken a look into the Injecting Environment variable at the Job level by installing Environment inject plugin. In this case also, user has to come to the configuring the job and set up.
Please let me know if there is a way to have the external script file and set the environment variable through it.
You can use the "This project is parameterized" option in jenkins job configure page and pass the arguments.
You can also have "environment" block in Jenkinsfile to declare all the variable.
environment {
CC = 'clang'
}
Please follow the link for more information.
please refer https://jenkins.io/doc/book/pipeline/syntax/#environment
pipeline {
agent none
environment {
field = 'some'
}
stages {
stage ('Preparation') {
agent { label 'master'}
environment {
JENKINS_PATH = sh(script: 'pwd', , returnStdout: true).trim()
}
steps {
echo "Hello world"
echo "PATH=${JENKINS_PATH}"
sh 'echo "JP=$JENKINS_PATH"'
}
}
}
}
I am trying to automate my build using Jenkins. My build process needs to execute three different shell scripts. The first script sets some environment variables which is used by the second and the third scripts.
I am trying with a pipeline job in Jenkins where each script is executed stage by stage. However I am unable to get the environment variables from the first script to the next one.
NB: There is a set of variables that are being set.So I don't feel like using a simple variable will do.
Please help
You are probably confusing declarative pipeline with scripted pipeline
Jenkinsfile (Declarative Pipeline)
pipeline {
agent any
environment {
DISABLE_AUTH = 'true'
DB_ENGINE = 'sqlite'
}
stages {
stage('Build') {
steps {
sh 'printenv'
}
}
}
}
Jenkinsfile (Scripted Pipeline)
node {
withEnv(['DISABLE_AUTH=true',
'DB_ENGINE=sqlite']) {
stage('Build') {
sh 'printenv'
}
}
}
In jenkins declarative pipeline, how can I set the value of an environment variable based on custom groovy/powershell method? For instance, if I have a delcarative pipeline as follows, can I use a shared library method to set this value?
Essentially I am trying to use a multibranch Declarative Pipeline jenkins job which has a deploy stage, but I need to ensure that develop branches are deployed to DEV, Release branches are deploying to STG, but using the same pipeline. My thought was to create an environment variable that is set based on a custom method (in perhaps Groovy in shared library), and that method would simply look at the current value for env.BRANCH and simply have a little logic to set the value of the target deploy environment. Here is an example of what I envision
pipeline {
environment {
DEPLOY_ENV = mapBranchToDeployEnvironment(${BRANCH})
}
And then in my deploy stage I would use this value in two powershell invocations
bat "powershell .\\Deploy-Service -Environment ${DEPLOY_ENV}"
bat "powershell .\\Deploy-ServiceProxy -Environment ${DEPLOY_ENV}"
Otherwise, How are people current solving the problem of using the same pipeline to deploy to different environments while using the variables across many other function invocations? What is the recommended approach from Jenkins on mapping a branch name that triggered the build to an environment (if any) it should be deployed to?
Based on my understanding, the Declarative Pipeline allows a pipeline to be "multibranch", which, if the job deploys as well, it needs to map to an deploy environment. How else would a pipeline deploy using multibranch to multiple environments when all the global jenkins pipeline environment variables are the same value for every job /branch execution?
In the above scenario, the pipeline variable 'DEPLOY_ENV' is derived from other environment variables that are set by the job and are available typically at the stage level, but here we are looking to set the value globally so that we can use it across stages
Update: My issue was that I didnt realize how simple it was and instead thought that I had to pass in a stage or script object into a groovy shared library function, when in fact its as simple as creating a shared library, then directly referencing the environment variables in the method. Easy. Thank you.
I had exactly the same problem, and indeed it is possible to use a shared library method. But there is another solution, more simple if you do not have a shared library set-up yet, that consists in defining a groovy method before the Pipeline statement and then use it inside your pipeline like this :
def getEnvFromBranch(branch) {
if (branch == 'master') {
return 'production'
} else {
return 'staging'
}
}
pipeline {
agent any
environment {
targetedEnv = getEnvFromBranch(env.BRANCH_NAME)
}
stages {
stage('Build') {
steps {
echo "Building in ${env.targetedEnv}"
}
}
}
}
You can do exactly what you're suggesting. You should create a jenkins shared library with a var (a new DSL method). These can be called to assign to a pipeline-wide environment variable. You had it basically correct. Here's a Jenkinsfile fragment to assign to an environment variable:
environment {
DEPLOY_ENV = mapBranchToDeployEnvironment()
}
You don't need to pass the branch to the mapBranchToDeployEnvironment DSL method, since you can access the branch in that method. sample contents of vars/mapBranchToDeployEnvironment.groovy in shared library look like this:
def call() {
echo "branch is: ${env.BRANCH_NAME}"
if (env.BRANCH_NAME == 'master') {
return 'prod'
} else {
return 'staging'
}
}
You probably shouldn't expect this to be a five minute task, but you'll get it. Good luck!
stage('Prepare env variables') {
steps {
script {
if (env.BRANCH_NAME == 'master') {
echo 'Copying project-stg.env file...';
sh 'cp /opt/project-stg.env .env';
} else {
echo 'Copying project-dev.env file...';
sh 'cp /opt/project-dev.env .env';
}
}
}
}