You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kw...@apache.org on 2026/06/08 17:29:12 UTC

(maven-jenkins-lib) 01/01: Clarify how to reference custom steps

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch feature/improve-readme
in repository https://gitbox.apache.org/repos/asf/maven-jenkins-lib.git

commit c626946e75667664834d3ee8fc144312211e2744
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Jun 8 19:29:04 2026 +0200

    Clarify how to reference custom steps
    
    Corrected typos in the README and clarified library description.
---
 README.adoc | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.adoc b/README.adoc
index fc3723b..36a4a20 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,6 +1,8 @@
-== Apache Maven Jenkins Shared Libraries
+= Apache Maven Jenkins Shared Librariy
 
-This repository contains the Jenkins shared libraries that define the standard build process for Apache Maven subprojects.
+This repository contains the Jenkins shared library that define the standard build process for Apache Maven subprojects.
+It consist of two different https://www.jenkins.io/doc/book/pipeline/shared-libraries/#defining-custom-steps[entry points (custom steps)] 
+which can be referenced from Maven repo's `Jenkinsfile`:
 
 == asfMavenTlpPlgnBuild() (building Maven plugins)
 
@@ -31,3 +33,10 @@ Example to use a specific set of jdks and maven core
 ```
 asfMavenTlpStdBuild(jdks:[ "8", "11" ], maven: "3.6.x")
 ```
+
+== Configuration in Jenkins
+
+This library is configured globally in https://ci-maven.apache.org/manage/configure[ci-maven.apache.org system settings] with name `maven-jenkins-lib`.
+
+The `master` branch is https://www.jenkins.io/doc/book/pipeline/shared-libraries/#using-libraries[loaded implicitly].
+You can reference another branch via https://www.jenkins.io/doc/book/pipeline/shared-libraries/#using-libraries[`@Library('maven-jenkins-lib@mybranch') _`].