Jenkins Shared Library Migration Guide

Latest News
5/22/2024

New optional customParameters field has been added to allow a project to define custom build parameters whose values can be exported as environment variables. See the YAML configuration page for more info.

3/15/2024

  • Jenkins Shared Library now supports setting the JIRA component field in issues generated by OIS scan reporting. Add the jiraComponent field to jenkins.yaml corresponding to the project’s JIRA component name to enable this. If it isn’t set it will use the value of artifactId of either the jenkins.yaml or pom.xml if not set.

  • NGSS Maven Tiles has been updated to 1.5.3 to fix an issue with docker-maven-tile-plugin not setting the base image’s URL prefix correctly.

3/5/2024

Jenkins Shared Library has been updated to manage OIS Scans in a more flexible way, adding the RUN_OIS_SCAN_ONLY build parameter for manually executing the scans when a full rebuild isn’t possible (in the case of successful release branch builds) or desired.

More details can be found on the Customize jenkins.yaml page. The new jenkins.yaml fields to support this capability have been added to the Jenkins Shared Library YAML configuration page.

2/28/2024

CI File Generator 4.12.1 has been released to address a NullPointerException being thrown when metadata.yaml build field is not present and running mvn filegen:jenkins-yaml -Dinit.

ngss-maven-tiles 1.5.2 has been released to update default base image versions as well as set the default CI File Generator version to 4.12.1.

Overview

Beginning with CI File Generator Release 4.12.0, support was added for including the NGSS Jenkins Shared Library instead of having to statically generate Jenkinsfiles for each project. This library also includes built-in support for the new OIS scanning capability (also implemented as a Jenkins shared library), and is the only way to automatically integrate this feature into the CI build configuration.

Likewise, ngss-maven-tiles release 1.5.x sets the new default version for its ci-file-generator-tile POM configuration to 4.12.x.

Following this guide when upgrading to ci-file-generator 4.12.x or ngss-maven-tiles 1.5.x will assist in applying the changes needed to successfully use the new shared libraries within your project.

For Go projects: Visit Guidance for Go Projects for guidance in integration, as there is additional configuration needed to get it working.

Table of Contents