(maven-jenkins-lib) branch master updated: Clarify how to reference custom steps (#19)

[kw...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 96c3704  Clarify how to reference custom steps (#19)
96c3704 is described below

commit 96c37047fc7c525077b3e4862628c8dcc43b500b
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Jun 8 19:47:21 2026 +0200

    Clarify how to reference custom steps (#19)
    
    Corrected typos and clarified library description.
    Add downstream dependencies section to README
---
 README.adoc | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/README.adoc b/README.adoc
index fc3723b..70d3bad 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,6 +1,8 @@
-== Apache Maven Jenkins Shared Libraries
+= Apache Maven Jenkins Shared Library
 
-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 defines 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,15 @@ 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') _`].
+
+== Downstream Dependencies
+
+This library uses custom steps provided by https://github.com/apache/maven-jenkins-env[Apache Maven Jenkins Environment Shared Library] which helps 
+referencing proper JDK/Maven installations available in Jenkins.