Jenkins : Pipeline Groovy Plugin

A component of Pipeline Plugin.

Changelog

2.74 (29 Aug 2019)

• Fix: Do not attempt to store enums defined in Pipeline scripts that are passed as arguments to Pipeline steps in ArgumentsActionImpl to avoid leaking Pipeline script class loaders. (PR 318)
• Fix: Do not try to open the listener for a completed build when looking up environment variables through EnvActionImpl. (JENKINS-59083)
• Internal: Add regression tests for SECURITY-1465. (PR 310)

2.73 (01 Aug 2019)

• Fix: The generated GDSL file used to support syntax highlighting for Pipeline scripts in IntelliJ IDEA incorrectly reported some step parameter types as Map when they should have been List, and did not support the parallel step. (JENKINS-30572)
• Fix: Do not log CPS method mismatch warnings for some false positives related to metaprogramming. (JENKINS-58501)
• Improvement: Log a warning when named arguments passed to a Pipeline step cannot be bound to any parameter of that step (for example because the argument is spelled incorrectly). Previously, such arguments were silently ignored. (JENKINS-33217)
• Improvement: Integrate the StepListener API added to Pipeline API Plugin version 2.36 (JENKINS-58084)
• Internal: Add additional tests for false positive CPS mismatch warnings (PR 309)
• Internal: Speed up some tests using ClassRule. (PR 308)
• Internal: Migrate tests related to snippet generation for the build step to Pipeline Build Step Plugin (PR 303)

2.72 (11 Jul 2019)

• Fix: Prevent a StackOverflowError from being thrown when calling overridden methods using super in some class hierarchies in a Pipeline. (JENKINS-52395)
• Internal: Update tests to fix PCT failures and unignore tests that no longer fail. (PR 290, PR 302)

2.71 (05 Jul 2019)

• Fix: Allow script-level initializers (including @Field) in sandboxed Pipelines. Fixes a regression from version 2.64. (JENKINS-56682)
• Improvement: Print detailed warnings to the build log when CPS-transformed code is called in a non-CPS context where possible. The warnings link to https://jenkins.io/redirect/pipeline-cps-method-mismatches/ which gives additional context and some examples of how to fix common issues. (JENKINS-31314)
• Fix: Catch additional types of exceptions when calling GraphListener methods. (PR 292)
• Internal: Build and test on Java 11, light refactoring and simplification, fix flaky test. (PR 294, PR 295, PR 296, PR 298)

2.70 (03 Jun 2019)

• Improvement: Interpret the DynamicContext extension point added in Pipeline Step API Plugin version 2.20. (JENKINS-41854)

2.69 (28 May 2019)

• Fix: Prevent a memory leak that could occur when shared libraries were used inside of a node step. (JENKINS-50223)
• Fix: Make an internal collection thread-safe to prevent an IOException with the message "cannot find current thread" from being thrown intermittently when using some types of non-blocking steps. (JENKINS-56890)

2.68 (10 May 2019)

• Fix: Improve handling of step arguments that cannot be data-bound. Fixes some cases where a non-fatal NoStaplerConstructorException would be visible in logs. (JENKINS-54186)
• Fix: Simplify stack traces for code inside of Pipeline libraries to avoid issues deserializing those stack traces. (JENKINS-57085)
• Fix: Make the support bundle component that provides Pipeline timing information more robust so that errors in one build do not keep timing information from being added to the support bundle for other builds. (PR 283)

2.67 (19 Apr 2019)

• Improvement: Better handling of RejectedAccessException  within try/catch  and catchError  blocks. (JENKINS-34973)

2.66 (11 Apr 2019)

• Fix: parallel and load steps did not clean up internal state correctly after their executions completed, leading to failures upon resuming a Pipeline and various kinds of memory leaks in some cases. (JENKINS-41791)
• Fix: When checking out a Pipeline from SCM, the support for SCM retry count did not retry the checkout attempt for certain kinds of errors when it should have. (PR 274)
• Improvement: Avoid logging certain kinds of unhelpful warnings when determining whether a Pipeline should block Jenkins from restarting (PR 277).
• Improvement: Update samples to use the non-deprecated archiveArtifacts step instead of archive. (PR 273)
• Improvement: Fix documentation for the params variable explaining how to use it with a default value. (JENKINS-56688)
• Improvement: Add internationalization support and Chinese localization for "Pipeline Syntax" links. (PR 276)

2.65 (25 Mar 2019)

• Fix security issue

2.64 (06 Mar 2019)

• Fix security issue

2.63 (01 Feb 2019)

• Enhancement: Enable the StepEnvironmentContributor extension point added in version 2.19 of Pipeline Step API Plugin (JENKINS-51170)
• Fix: Notify global GraphListener implementations of FlowStartNodes when a Pipeline build begins (JENKINS-52189)

2.62 (14 Jan 2019)

• Fix: Trim Pipeline script path (e.g. Jenkinsfile) when using a Pipeline script from SCM (JENKINS-55424)
• Add a link to Pipeline Examples from the sidebar of the Pipeline Syntax page.
• Add support for GeneralNonBlockingStepExecution utility added to Pipeline Supporting APIs 2.18 (JENKINS-49337)
• Avoid use of deprecated APIs (PR 256)

2.61.1 (8 Jan 2019)

• Fix security vulnerability

2.61 (30 Nov 2018)

• Fix: Catch errors thrown by GraphListeners during Pipeline execution so that they do not cause the build to fail (JENKINS-54890)
• Improvement: Only construct log messages when the specified logging level is enabled to improve performance in some cases

2.60 (29 Oct 2018)

• Fix security issue

2.59 (17 Oct 2018)

• Improvement: Limit the types of Step arguments stored for visualization (JENKINS-54032)
  • Solves memory leaks for some plugins that abuse Step arguments by passing Pipeline-internal objects
  • Better protects against storing potentially problematic object types, and may reduce their memory use
  • Applies filtering to Describable objects passed by legacy syntaxes, so that filtering can be applied to their fields

2.58 (12 Oct 2018)

• Internal bug fix important for display of steps in classic UI after update of Pipeline Job Plugin to 2.26.
• Minimum Jenkins Core version updated to 1.121.1

2.58-beta-1 (2018 Oct 04)

• Internal bug fix important for display of steps in classic UI after update of Pipeline Job Plugin to 2.26-beta-1.

2.57 (Oct 2, 2018)

• Fix: Make compilation errors when using the load step serializable so that the actual compilation error is reported instead of a NotSerializableException (JENKINS-40109).
• Improvement: Add localization support for a message on the global variable reference page. Thanks Unknown User (surenpi)!

2.56 (Sep 27, 2018)

• Fix: Do not persist Pipeline context variables that are no longer in scope. In particular, this fixes some cases where resuming builds outside of a node block would wait for an agent used previously in the Pipeline to become available (JENKINS-53709)
• Improvement: Chinese localizations have been migrated to the Localization: Chinese (Simplified) Plugin. Thanks LinuxSuRen!

2.55 (Sep 10, 2018) 

• Improvement: Allow steps to be invoked using their full class name to avoid ambiguity, and log a warning when ambiguous steps are invoked (JENKINS-53333)
• Various documentation and localization improvements. Thanks to community contributors LinuxSuRen and rodrigc for those improvements!

2.54 (Jun 25, 2018) 

• Fix: Do not use com.google.common.io.NullOutputStream

2.53 (May 8, 2018) 

• Fix: Fix deadlocks with WorkflowRun#copyLogs() + CPS things (tracked in comments for JENKINS-51132)

2.52 (May 4, 2018) 

• Fix: Fix a critical deadlock with CpsFlowExecution#getCurrentHeads introduced in 2.50 due to https://github.com/jenkinsci/workflow-cps-plugin/pull/223 (JENKINS-51132)
  • Thanks to community contributor for correctly identifying it and Laurent Goujon providing a fast fix!

2.51 (May 3, 2018) 

• Fix: Allow the FlowExecution to still be saved if a Pipeline build (WorkflowJob) is modified and saved before the lazy load of the FlowExecution is done (onLoad not invoked on the execution) (JENKINS-50888)

2.50 (May 2, 2018) Significant Bugfixes, Suggested Upgrade

• We strongly encourage installing this update due to the issues resolved, and suggest combining with an upgrade to Pipeline Job (workflow-job) plugin v2.21 or later
• Major Fix: NullPointerException in CPS VM thread for builds with certain data not properly persisted (JENKINS-49686)
• Fix/Improvement: Pipelines ensure that when part of the information is persisted, all necessary pieces to load that information are also persisted
• Improvement: re-do the persist-at-shutdown behavior to be more robust
• Improvement: even if one Pipeline fails to persist at shutdown, allow other Pipelines to attempt to persist
• Fix: A variety of synchronization consistency problems
• Improvement: Rewrite handling of missing FlowNodeStorage and creation of placeholder nodes to ensure correctness and done state is persisted
• Fix: Pipelines blocking restart of Jenkins masters if they failed to resume or threw an exception when loading the Pipeline program
• Fix: Pipeline builds showing as incomplete when they failed to resume or load
• Greatly expanded test coverage for persistence and edge-cases where incorrect data is persisted

2.49 (Apr 20, 2018)

• Bugfix: Solve Replay not being visible or usable for builds (regression from lazy load of executions introduced in workflow-job) (JENKINS-50874)
• Bugfix: CpsScript invokeMethod does not execute closures defined in the script binding - thanks steven-terrana
• Maintenance: Stop using the Junit Step in Metastep tests (prevents Plugin Compatibility Test failurs)

2.48 (Apr 12, 2018) 

• Bugfix: FlowNode Serialization Could Fail Due to Unserializable Step Arguments (JENKINS-50752)
  • This could trigger deeper failures in Pipeline due to the serialization failures before workflow-api 2.27

2.47 (Apr 8, 2018)  Significant Bugfixes, Suggested Upgrade

• Major bugfix / improvements: numerous fixes & improvements to make Pipeline persistence & resume more robust (across all Durability Settings)
  
  • These do not have individual JIRAs because they were spinoffs from testing other work, discovered with fuzzing-like approaches
  • Many of these bugs would result in irreproducible errors that may have been reported - link any related JIRAs here: (TBD)
  • Improves error-handling logic
• Part of Major Bugfix: Error "NullPointerException in CPS VM thread at WorkflowRun$GraphL.onNewHead" as result of a race condition (JENKINS-49686)
  • The other part of the bugfix is in the Pipeline Job Plugin - version 2.18
• Part of Major Bugfix: Failed pipelines resume and won't die even when marked to not resume, and show resume failures  (JENKINS-50199)
  • The other part of the bugfix is in the Pipeline Job Plugin - version 2.18
• Part of Bugfix: Error "NullPointerException in SandboxContinuable.run0" after restart in Performance-Optimized Durability Setting (JENKINS-50407)
  • The other part of the bugfix is in the Pipeline Job Plugin - version 2.18

2.46 (April 5, 2018)

• JENKINS-45575, JENKINS-49679 - Fix a couple issues with multiple assignment.
• JENKINS-49961 - Fix an NPE when toggling ResumeEnabled when FlowExecutionOwner is not yet set.
• JENKINS-45982 - Fix calling a CPS-transformed super.
• JENKINS-33614 - Include link to script approval for RejectedAccessException - but only when the user viewing the console has permissions for script approval.
• JENKINS-50171 - Avoid LinkageError with load step of Groovy files with a package declaration on resume of Pipeline.

2.45 (Feb 14, 2018)

• Enhancement: Improve performance of running pipelines - reduce CPU, wall time, and disk IO.  
  • Works by eliminating reflection and classloading needed to determine how many arguments a Step needs
• Enhancement:  In Snippetizer, support Symbol use with different lists of inputs to steps (JENKINS-37215)
• Misc: Pick up more modern structs, and reduce memory garbage for steps slightly by using DescribableModel.of API

2.44 (Jan 31, 2018)

• Pick up recent groovy-cps fixes including resolving a quirk with field initialization and CPS transforms
• Implement support for SCM retry count - JENKINS-39194

2.43 (Jan 22, 2018)

• Major Feature: Support for faster Durability Settings which reduce I/O and improve performance significantly (JENKINS-47300)
• Major Feature: ability to disable Pipeline auto-resume when restarting (JENKINS-33761)
• Major Feature: consolidate writing FlowNodes using granular persistence APIs (JENKINS-47172)
• Robustness Enhancement: a giant wad of fixes to ensure we handle persistence failures and oddball circumstances
  • Extensive test coverage, plus protects against some "hung" pipeline states and other weird bugs
• Enhancement: reduce memory used by Pipeline for storing Step arguments (PR #65)
• Bugfix: first Pipeline step lacks displayed arguments (JENKINS-48644)

2.42 (Nov 29, 2017)

• Compatibility Note: this is the first version requiring Java 8 (Jenkins LTS 2.60.x+)
• JENKINS-44619 - Don't allow replaying unbuildable jobs
• Rename ReplayCommand to ReplayPipelineCommand
• JENKINS-47339 - Allow users with Build permission but not Configure permission to replay a build with the same script.
• JENKINS-46597 - Fix IteratorHack to handle SortedMap, like TreeMap, without serialization issues. 
• Protect against unlimited recursion with a sane error.

2.41 (Sept 28, 2017)

• JENKINS-47071 - Allow .every, .any, and other closure methods involving booleans to serialize properly.
• Reduce memory of CPS code significantly by lazily initializing locals maps
• JENKINS-44027 - Support multiple assignment in Pipeline scripts
• JENKINS-32213 - Automatically make all CPS-transformed classes Serializable, no longer requiring that to be done explicitly.
• Do not even offer PauseUnpauseAction unless you actually have CANCEL permissions

2.40 (Sept 5, 2017)

• JENKINS-34645 - Serialize array iterators properly
• JENKINS-46391 - Correctly translate ~/foo/ as a regexp
• JENKINS-46358 - Support for a number of StringGroovyMethods

2.39 (Aug 7, 2017)

• Fixes for multiple security issues in script security plugin

2.38 (Aug 1, 2017)

• JENKINS-44548 Fix NullPointerException caused by corrupted FlowExecution records

2.37 (Jul 25, 2017)

• Robustness fix involving StepContext.get(FlowNode) calls.

• JENKINS-45109 Metastep display improvements useful especially for step and wrap calls in Blue Ocean.

• JENKINS-31582 API for obtaining step arguments in more realistic form.

• Improved logging of @script checkout.

2.36.1 (Jul 10, 2017)

• Fix security issue

2.36 (Jun 15, 2017)

• Enabling whitelist entries to work for most Groovy built-in methods enabled in 2.33.
• Timeouts in CpsFlowExecution.suspendAll could block Jenkins shutdown.

2.35 (Jun 13, 2017)

• [38268@issue] Improper binding of local variables in closures.
• Functional tests sometimes failed due to DSL finding no step definitions.

2.34 (Jun 03, 2017)

• JENKINS-44578 Corrects a StackOverflowError seen on some JVMs with limited stack size running Declarative Pipelines after updating to 2.33.

2.33 (May 30, 2017)

Requires Jenkins 2.7.x or later.

• JENKINS-26481 Most Groovy built-in methods taking closures (such as List.each) may now be used from Pipeline script without @NonCPS annotations. Certain less commonly used methods (such as sort taking a closure) are not yet implemented.

• JENKINS-27421 Most Java methods returning iterators (such as looping over the result of Map.entrySet) may now be used from Pipeline script without @NonCPS annotations.

• JENKINS-31967 Pipeline Syntax support for double values, as in the junit step for example.

• JENKINS-43055 GraphListener may now be used as an extension point.

  GROOVY-6263 will affect Jenkins installations until Groovy 2.5.0 is integrated. Briefly, private methods may not be visible if called from an instance of a subclass of the class defining the method. The workaround is to relax the access restriction, for example to protected.

  Users of Declarative Pipeline should update to 2.34.

2.32 (May 24, 2017)

• Timing feature in 2.31 introduced a memory leak when using shared libraries.

2.31 (May 22, 2017)

• JENKINS-37324 Store and display arguments supplied to steps

• JENKINS-44406 Fix a NullPointerException from StepDescriptorCache when the plugin providing the Step is uninstalled

• Record timing information for various internal operations in Pipeline builds, available when support-core is installed.

• Deleting program.dat when a build finishes.

2.30 (Apr 24, 2017)

• Robustness fix related to JENKINS-26137.

• JENKINS-43361 Unreproducible NullPointerException.

• JENKINS-43019 ClassCastException under certain circumstances involving libraries.

2.29 (Mar 03, 2017)

• JENKINS-33273 New option for script-from-SCM jobs to load the script directly, rather than performing a full checkout. Requires a compatible SCM, currently Git. Enabled by default for new jobs (falls back to heavyweight checkout where necessary).
• JENKINS-42367 NullPointerException using params when certain kinds of parameter values were missing.

2.28 (Feb 23, 2017)

• JENKINS-42189 Problems in memory cleanup when using Groovy 2.4.8 (Jenkins 2.47+) could lead to deadlocks and/or large heap consumption.
• Flow node IDs incorrectly skipped even numbers after around 500.

2.27 (Feb 13, 2017)

• JENKINS-41945 NullPointerException during build cleanup, and consequent memory leak, under heavy load.
• JENKINS-32986 Apply timeouts to some operations in the CPS VM thread.
• Ensure build terminates after certain internal errors.

2.26 (Feb 07, 2017)

• Pull in workflow-api 1.10 and refactor StepNode so that libraries can obtain Step info without depending on workflow-cps

2.25 (Feb 01, 2017)

• JENKINS-39719 Cryptic error about overriding methods named like __cps__2 under certain conditions involving global libraries.
• JENKINS-31484 Incorrect CPS translation of field references from getters and setters could lead to endless loops.

2.24 (Jan 17, 2016)

• Reducing frequency of program.dat saves, avoiding some otherwise harmless serialization errors, and possibly improving performance for builds with complex Groovy logic.
• Correcting two kinds of NullPointerException when loading old build records.
• JENKINS-29656 Avoid failing the build merely because renaming a temporary file to program.dat fails, typically on Windows due to file locks from antivirus scanners.
• JENKINS-38551 Invalid characters in GDSL.
• Performance improvement related to StepDescriptor.

2.23 (Nov 07, 2016)

• Fixed a number of memory leaks, extending fixes made in 2.12.
• JENKINS-39456 Reduce memory footprint from graph of execution.
• Language fixes, including support for:
  • super.method(…) calls
  • abstract methods
  • list to constructor coercion

2.22 (Nov 01, 2016)

• Bug fix required for proper display of JENKINS-28385 in step reference.
• JENKINS-39275 Cap the amount of time spent displaying one line of a virtual thread dump.
• Text changes in Pipeline Syntax page.

2.21 (Oct 21, 2016)

• JENKINS-39154 In-browser Pipeline script editor was broken in 2.20.

2.20 (Oct 20, 2016)

• JENKINS-34637 timeout did not work when using most nested block steps.
• Improved behavior on NotSerializableException such as in JENKINS-27421.

2.19 (Oct 11, 2016)

• JENKINS-35698 params now honors currently defined parameter definition defaults.
• Global variables now take precedence over environment variables in case of ambiguity.
• Clarifying and enforcing that params is read-only.

2.18 (Sep 23, 2016)

• JENKINS-29952 env.PROP may now be shortened simply to PROP when unambiguous. (Setting a variable still requires the prefix, or the withEnv step.)
• JENKINS-27295 Build parameters may now be accessed via the params global variable, with typed values.
• JENKINS-38114 currentBuild global variable documentation now displayed in full, rather than referring to build step documentation; and updated to better explain usage in light of changes in 2.14.
• Unreproducible case of an error during build abort handling of a step making the build not abort cleanly.
• Fixed a certain class of build hangs due to code mistakes, and improved error reporting for these cases.
• Improved display in the build log of predictable problems resuming a build, such as cancellation of queue items for offline agents inside a node block.
• Adding HTML anchors to the Global Variable Reference for easier linking.

binding.hasVariable('paramName') ? paramName : 'fallback'

params.paramName ?: 'fallback'

env.paramName ?: binding.hasVariable('paramName') ? paramName : 'fallback'

2.17 (Sep 13, 2016)

• JENKINS-38169 Regression in 2.14 affecting certain steps with a single parameter.

2.16 (Sep 13, 2016)

• JENKINS-38167 Regression in 2.14 affecting certain usages of @Field.

2.15 (Sep 07, 2016)

• JENKINS-38037 Regression in 2.14 affecting certain usages of symbols, such as with artifactArchiver in Jenkins 2.

2.14 (Sep 07, 2016)

• JENKINS-29711 Fixed Snippet Generator output for steps taking a single array of arguments, and fixed the runtime for steps taking a single fixed argument, both with an implicit parameter name.
• JENKINS-25623 Ability to abort/timeout an endless loop of Groovy code not inside any step.
• Updated the Maven sample offered for fresh jobs.
• Updated samples and code completion to use block-scoped stage from JENKINS-26107.
• Fixed link text.
• Infrastructure for JENKINS-31155.

@NonCPS def entrySet(m) {m.collect {k, v -> [key: k, value: v]}}

2.13 (Aug 25, 2016)

• JENKINS-37538 Trying to correct a regression in 2.12. Unreproducible but reported to affect usages of the Artifactory and Subversion plugins.

2.12 (Aug 15, 2016)

• Correcting a memory leak introduced with the fix of JENKINS-36372, as well as a longstanding leak affecting only Jenkins 2.x.
• Print a message whenever we are ready to resume running the program. Normally immediately after Resuming build but could be delayed for various reasons, such as offline agents.
• Setting the thread context class loader, improving performance on systems running numerous Pipeline builds with complex Groovy scripts if you also update Script Security Plugin to 1.22.

2.11 (Aug 09, 2016)

• JENKINS-29922 follow-up from 2.10: single-argument metasteps such as step and wrap should now display their delegates like first-class steps in Snippet Generator.
• JENKINS-29922 follow-up from 2.10: error reporting for undefined functions now mentions available symbols as well as steps.
• Include the running node count in Pipeline thread dumps in support bundles, to help estimate size of the Pipeline script and its libraries.
• Infrastructure for JENKINS-34650.

2.10 (Jul 28, 2016)

• JENKINS-29922 Simplified step call syntax available for certain cases where previously the $class notation was required.
• JENKINS-25736 Ability to pause a running build.

2.9 (Jul 05, 2016)

• JENKINS-36372 Root bindings not accessible to scripts loaded after restart.

2.8 (Jun 29, 2016)

• JENKINS-31842 The virtual thread dump for a running build can now display information about the status of running steps.
• JENKINS-36289 API for accessing Replay from Blue Ocean.

2.7 (Jun 27, 2016)

• Some Snippet Generator forms were not using the correct job context since 2.3; affected Credentials dropdowns, for example.
• Show the Pipeline Syntax link also from Replay screens.
• Improved the Maven script sample in the inline editor.

2.6 (Jun 16, 2016)

• JENKINS-26481 Pending a true fix for passing closures to “binary” methods such as Collection.each, the Pipeline build should now fail with an error message mentioning the issue, rather than silently behaving in an erratic fashion.
• JENKINS-35395 Moving documentation for global variables into their own page for clarity.
• Missing colon in editor snippet.
• Infrastructure for JENKINS-26130: display information in the build log after Resuming build about what objects are still being loaded.

2.5 (Jun 09, 2016)

• JENKINS-34281 workaround: some builds could fail to resume properly in a Jenkins installation with no anonymous read access, depending on how Jenkins was shut down.

2.4 (May 25, 2016)

• Adding another link to Pipeline Syntax from a job configuration screen itself, to make it more prominent for Jenkins 2.x users without a sidebar.

2.3 (May 23, 2016)

• JENKINS-31831 Moving Snippet Generator and related content to a new set of top-level pages under the label Pipeline Syntax.
• API implementation useful for JENKINS-26107.

2.2 (May 02, 2016)

• Enable the Groovy sandbox by default, even for administrators.
• Improved log appearance of block-scoped steps.
• JENKINS-25894 Better error reporting inside parallel.
• Flow node graph improvement for load step.
• JENKINS-26156 API problem in BodyInvoker.withDisplayName.

2.1 (Apr 06, 2016)

• JENKINS-34064 Fix of JENKINS-26481 reverted for now since it broke all Pipeline scripts in Jenkins 2.0 betas.

2.0 (Apr 05, 2016)

• First release under per-plugin versioning scheme. See 1.x changelog for earlier releases.
• JENKINS-26481 list.each {…} now works from Pipeline scripts (without @NonCPS).
• JENKINS-27421 for (def x in list) {…} now works from Pipeline scripts (without @NonCPS).