Chapter 4. Configuring RHTAP to use built-in Jenkins libraries

Procedure

1. Log in to Jenkins and navigate to Manage Jenkins > System.
2. Locate the Global Trusted Pipeline Libraries section.

3. Click Add and define the new library with the following parameters:

   1. Name: <your-library-name>
   2. Default version: Set to a specific branch or commit reference. For example, v1.5.
   3. Allow default version to be overridden: (Optional) Select this option to restrict users to a specific version of the Jenkins library. This ensures that the users cannot select a different version.
   4. Include @Library changes in your recent changes: Select this option to track modifications made to the shared library. This feature helps users understand changes that might affect their builds.

   5. Retrieval method: Select Modern SCM.

      1. From the Source Code Management drop-down list, select Git.
      2. In the Project Repository field, enter the Jenkins library URL. For example, https://github.com/redhat-appstudio/tssc-sample-jenkins.
      3. Select Fresh clone per build, to ensure each build fetches a clean copy of the library.
      4. Select Save.

Procedure

1. Navigate to your Jenkins CI source repository, For example, https://github.com/redhat-appstudio/tssc-sample-templates/blob/main/skeleton/ci/source-repo/jenkins.
2. Select Jenkinsfile in edit mode.

3. Replace the dynamic library loading with the @Library annotation.

   Expand

   Replace this	With this
   library identifier: 'RHTAP_Jenkins@main', retriever: modernSCM( [$class: 'GitSCMSource', remote: 'https://github.com/redhat-appstudio/tssc-sample-jenkins.git'])	@Library('RHTAP_Jenkins@v1.5') _

   Show more
4. Save and commit the updated Jenkinsfile.

Procedure

1. In your Jenkins instance, navigate to your project.
2. Select Build Now to trigger a new build.

Verification

1. Check the Jenkins build logs to confirm that the built-in library is loaded instead of dynamically retrieving dependencies.
2. Validate that Enterprise Contract attestations now reflect a built-in library.
3. Verify the library name, retrieval method, and pipeline script if any error occur.