From 3fd7da10b1b302d92fd1cfa9362d919b9d691dfc Mon Sep 17 00:00:00 2001 From: Manuele Simi Date: Mon, 3 Feb 2020 15:38:33 -0500 Subject: [PATCH] Describe pipeline's expected parameters. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index efb0675..cff5c3a 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,11 @@ Jenkins Pipeline script to manage a complete gCube release. ## Expected parameters Parameters from the Jenkins pipeline project: -* Type: a choice of 'SNAPSHOT-DRY-RUN', 'SNAPSHOT', 'RELEASE-DRY-RUN', 'RELEASE-STAGING', 'RELEASE' +* Type: a choice of 'SNAPSHOT-DRY-RUN', 'SNAPSHOT', 'RELEASE-DRY-RUN', 'STAGING', 'RELEASE' * gCube_release_version: the gCube version to build (must match the YAML file in /releases) - +* cleanup_gcube_artifacts: a boolean flag to decide whether to wipe out the gCube artifacts from the local repository before the build +* cleanup_local_repo: a boolean flag to decide whether to wipe out all the artifacts from the local repository before the build +* resume_from: a build number. If specified, the new build will resume from the last failed job of that build ## References * [Jenkins Pipeline](https://jenkins.io/doc/book/pipeline/)