Environment Script Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID environment-script Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
1.1.2
Aug 09, 2012
1.466
Source Code
Issue Tracking
Maintainer(s)
GitHub
Open Issues
J��rgen P. Tjern�� (id: jorgenpt)
Usage Installations 2013-Apr 499
2013-May 569
2013-Jun 584
2013-Jul 660
2013-Aug 675
2013-Sep 716
2013-Oct 777
2013-Nov 786
2013-Dec 809
2014-Jan 855
2014-Feb 924
2014-Mar 979

Allows you to run a script before each build that generates environment variables for it.

Table of Contents

Description

Environment Script Plugin allows you to have a script run after SCM checkout, before the build. If the script fails (exit code isn't zero), the build is marked as failed.
Any output on standard out is parsed as environment variables that are applied to the build. It supports "override syntax" to append paths to PATH-like variables (through EnvVars.override in Jenkins).

Some information about how it runs:

  • It runs after SCM checkout, so you can refer to files from your SCM of choice.
  • Matrix builds are supported, and the script runs on each of the build combinations (sub-builds, or whatever you call them), not on the 'master' flyweight task that kicks off the other ones.
  • It supports "override" (through EnvVars.override) syntax for appending to PATH-like variables: PATH+myuniqueidentifier=/foo is the same as PATH=$PATH:/foo in shell-script (notice the : is added automatically).
  • If you want to fail a build from the script, just exit with status code 1.

Setup

To enable this plugin, go to the configuration page of the job you care about, and check the box named Generate environment variables from script.

Regular job

In your script, just print "FOO=bar" to the standard output to set that variable.

echo VARIABLE1=Hello World

If you want to append to an existing PATH-style variable, you can do:

echo PATH+unique_identifier=/usr/local/bin

Otherwise, you're free to do whatever your heart desires in this script - cat a file, run a script in some other language from your project's source tree, etc.

Matrix job

Matrix jobs are pretty much the same as regular jobs, except you get a new checkbox: Run only on parent. If you enable this option, the script will only run on the matrix "parent" job, and not on the individual "configuration builds" (sub-builds). The environment variables will still be propagated to the children.

This option comes in handy if you need to do something like generate a shared version number based on a timestamp - the code will only run once, but all the different configurations will get the variable. Here's an example - note that ONLY $VERSION is seen by the jobs, not $base_version and $unix_time.

base_version=$(cat version.txt)
unix_time=$(date +%s)
echo VERSION=${base_version}-${unix_time}

Known issues

Version history

1.1.2 (Aug 9, 2012)

1.1.1 (Aug 8, 2012)

  • Add help for "Only run on parent" option.
  • Improve help for "Script content".
  • Use java.util.Properties to parse instead of our own crappy one.

1.1 (Aug 8, 2012)

  • JENKINS-14701: Added option to run script only on the 'parent' of a matrix build (instead of on each individual 'configuration build'),

1.0 (Aug 6, 2012)

  • First release.

Labels

Edit
plugin-buildwrapper plugin-buildwrapper Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.