Code Monkey home page Code Monkey logo

jenkinsci-unstashparam-library's Introduction

Jenkins unstashParam Library

This pipeline library contains a workaround for Jenkins issue JENKINS-27413. It provides a new step unstashParam that saves file parameter to a workspace.

Configuration

See Jenkins User Handbook, chapter Extending with Shared Libraries on how to configure pipeline libraries.

Usage

In a pipeline script:

library "jenkinsci-unstashParam-library"
node {
   def file_in_workspace = unstashParam "file"
   sh "cat ${file_in_workspace}"
}

The above assumes the Jenkins job has a file build parameter named file.

License

This library is MIT licensed. See license.txt for details.

jenkinsci-unstashparam-library's People

Contributors

dmc avatar janvrany avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

jenkinsci-unstashparam-library's Issues

Fail in case there is no file

Given a file parameter with file location as RAC_INFO_REAL.xlsx
And node is a linux slave
When build the job with no file selected
Then the job workspace become an empty file (not a directory) causing pipeline failure

build.log

stage('upload') {
	steps {
		// delete workspace
		cleanWs()
		script {
			// handle file parameters in pipeline (JENKINS-27413)
			// https://stackoverflow.com/questions/59468464/fetching-uploaded-files-in-jenkins
			def file_in_workspace = unstashParam 'RAC_INFO_REAL.xlsx'
			sh "mv '${file_in_workspace}' RAC_INFO_REAL.xlsx"
                }
	}
}

Not working for xlsx file

I am using like this in my pipeline.

       def file_in_workspace = unstashParam "test_data.xlsx"
       sh "cat ${file_in_workspace} > test_data.xlsx"

for...in syntax is unsafe when presented with the CPS transform.

for (param in paramsAction.getParameters()) {

It's not clearly documented, but that construct is unsafe. See https://jenkins.io/blog/2017/02/01/pipeline-scalability-best-practice/ , specifically:

@NonCPS functions can use a much broader subset of the Groovy language, such as iterators and functional features, which makes them more terse and fast to write.

And while working around that, pay attention to:

@NonCPS functions should not use Pipeline steps internally, however you can store the result of a Pipeline step to a variable and use it that as the input to a @NonCPS function.

Gotcha: It’s not guaranteed that use of a step will generate an error (there is an open RFE to implement that), but you should not rely on that behavior. You may see improper handling of exceptions, in particular.

It's annoying, but it's there.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.