improve readme master
authorKonrad Windszus <kwin@apache.org>
Tue, 5 Jul 2022 07:42:10 +0000 (09:42 +0200)
committerKonrad Windszus <kwin@apache.org>
Tue, 5 Jul 2022 07:42:10 +0000 (09:42 +0200)
README.md

index 9152f98fc5a7ae021f7588b7e284885cb7d76322..135ad1954943589a25d12d15fe4843bac91fe4c4 100644 (file)
--- 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.)