[jackrabbit-filevault-jenkins-lib] branch master updated: improve readme

[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/jackrabbit-filevault-jenkins-lib.git


The following commit(s) were added to refs/heads/master by this push:
     new d36cbc0  improve readme
d36cbc0 is described below

commit d36cbc07e783bf238c60ce26f562c4ca85020cad
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Tue Jul 5 09:42:10 2022 +0200

    improve readme
---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9152f98..135ad19 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ It is supposed to be called in a `Jenkinsfile` like this
 
 ```
 vaultPipeline('ubuntu', 11, '3', {
-   vaultStageBuild(['ubuntu', 'Windows'], [8, 11, 17], ['3', '3.6.3'], 'apache_jackrabbit-filevault-package-maven-plugin') 
+   vaultStageBuild(['Windows'], [8, 17], ['3.6.3'], 'apache_jackrabbit-filevault-package-maven-plugin') 
    vaultStageDeploy()
   }
 )
@@ -18,6 +18,7 @@ The `vaultPipeline` step encapsulates the main build environment parameters:
 The first argument is the main *node label* to build with, the second one the main *JDK version*, third argument the main *Maven version*
 The fourth argument is a closure containing the actual stages where each may be one of
 
+1. `vaultStageSanityCheck`: a quick Maven build supposed to fail fast and executed before triggering expensive parallel builds with `vaultStageBuild`
 1. `vaultStageBuild`: the actual Maven build and SonarQube execution (the latter only for the main environment)
 1. `vaultStageIT`: an isolated execution of just the integration tests
 1. `vaultStageDeploy`: the stage to deploy the previously built Maven artifacts to the ASF Snapshot Repository (depends on 1.)