[RelEng] Introduce dry-run parameter in promotion pipeline

Author: HannesWell

JenkinsJobs/Releng/FOLDER.groovy

@@ -75,7 +75,11 @@ pipelineJob('Releng/prepareNextDevCycle'){
 	displayName('Prepare Next Development Cycle')
 	description('Perform all steps to prepare the next development cycle of Eclipse.')
 	parameters {
-		booleanParam('DRY_RUN', true, 'If enabled, the final publication of all changes is skipped. Useful for debugging and to very that the pipeline behaves as intended.')
+		booleanParam('DRY_RUN', true, '''\
+If enabled, the final publication of all changes is skipped respectivly all changes at the download-server happen in a 'try-out' area at https://download.eclipse.org/eclipse/try-outs/.
+This area is cleaned on each dry-run and should be cleaned after a try-out session is completed.
+Useful for debugging and to very that the pipeline behaves as intended.
+''')
 		stringParam('NEXT_RELEASE_VERSION', null, 'Version of the release to prepare, for example: 4.37')
 		stringParam('PREVIOUS_RELEASE_CANDIDATE_ID', null, 'Id of the current release-candiate for the previous release, for example: S-4.36RC2-202505281830')
 		stringParam('M1_DATE', null, 'Milestone 1 end date in the format yyyy-mm-dd, for example: 2025-07-04')
@@ -106,6 +110,7 @@ But also, allows the sites and repositories to be examined for correctness befor
 The second (deferred) step that makes things visible works, in part, based on some output of this first step. Hence, they must "share a workspace".
 ''')
 	parameters {
+		booleanParam('DRY_RUN', true, 'If enabled, the final publication of all changes is skipped. Useful for debugging and to very that the pipeline behaves as intended.')
 		stringParam('DROP_ID', null, '''\
 The name (or, build id) of the build to promote. Typically would be a value such as 'I20250714-1800'.
 It must match the name of the build on the build machine.

JenkinsJobs/Releng/promoteBuild.jenkinsfile

@@ -11,6 +11,7 @@ pipeline {
 	environment {
 		// Download Server locations (would very seldom change)
 		EP_ROOT = '/home/data/httpd/download.eclipse.org'
+		DRY_RUN_PREFIX = "${params.DRY_RUN ? 'eclipse/try-outs/' : ''}"
 	}
 	tools {
 		jdk 'temurin-jdk21-latest'
@@ -20,6 +21,7 @@ pipeline {
 		stage('Process input') {
 			steps {
 				script {
+					echo "DRY_RUN: ${DRY_RUN}"
 					env.DROP_ID = readParameter('DROP_ID')
 					if (!"${DROP_ID}") {
 						error("Parameter 'DROP_ID' is not specified")
@@ -71,6 +73,12 @@ pipeline {
 					} else if (env.SIGNOFF_BUG ==~ '\\d+') {
 						assignEnvVariable('SIGNOFF_BUG', "https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/issues/${SIGNOFF_BUG}")
 					}
+					
+					if (params.DRY_RUN) { // Clear 'try-outs' area on the starge server
+						sshagent(['projects-storage.eclipse.org-bot-ssh']) {
+							sh 'ssh [email protected] "rm -rf ${EP_ROOT}/eclipse/try-outs/"'
+						}
+					}
 				}
 			}
 		}
@@ -81,6 +89,7 @@ pipeline {
 					script { // Always load the script from the very same state this pipeline is loaded (to ensure consistency)
 						utilities = load "JenkinsJobs/shared/utilities.groovy"
 						githubAPI = load "JenkinsJobs/shared/githubAPI.groovy"
+						githubAPI.setDryRun(params.DRY_RUN)
 					}
 					sh '''#!/bin/bash -xe
 						git branch --force master HEAD
@@ -143,9 +152,12 @@ pipeline {
 									# Change to SSH, if the configured URL uses HTTPS (we can only push with SSH)
 									pushURL=$(echo $pushURL|sed --expression 's|https://github.com/|[email protected]:|')
 								fi
+								if [[ ${DRY_RUN} == 'true' ]]; then
+									dryRunFlag='--dry-run'
+								fi
 								# Enforce the (re-)creation of the tag in case of a very late respin
 								git tag --force -a -m "${SIGNOFF_BUG}" ${TAG} HEAD
-								git push --force --verbose ${pushURL} tag ${TAG}
+								git push --force --verbose ${dryRunFlag} ${pushURL} tag ${TAG}
 							}
 							tagBuild
 							export -f tagBuild
@@ -164,7 +176,8 @@ pipeline {
 					sshagent(['projects-storage.eclipse.org-bot-ssh']) {
 						sh '''#!/bin/bash -xe
 							sourceRepo="eclipse/updates/${BUILD_MAJOR}.${BUILD_MINOR}-I-builds/${REPO_ID}"
-							targetRepo="eclipse/updates/${BUILD_MAJOR}.${BUILD_MINOR}/${DL_DROP_ID}"
+							targetRepo="${DRY_RUN_PREFIX}eclipse/updates/${BUILD_MAJOR}.${BUILD_MINOR}/${DL_DROP_ID}"
+							ssh [email protected] mkdir -p "${EP_ROOT}/${targetRepo}/.."
 							ssh [email protected] cp -r "${EP_ROOT}/${sourceRepo}/." "${EP_ROOT}/${targetRepo}"
 
 							MIRRORS_URL="https://www.eclipse.org/downloads/download.php?file=/${targetRepo}"
@@ -257,9 +270,11 @@ pipeline {
 							if [[ "$pushURL" == http* ]]; then
 								pushURL=$(echo $pushURL|sed --expression 's|https://github.com/|[email protected]:|')
 							fi
-							
-							git push --force ${pushURL} "master:refs/heads/update-build-to-R${BUILD_MAJOR}.${BUILD_MINOR}"
-							git push --force ${pushURL} "updateMaintenance:refs/heads/update-${MAINTENANCE_BRANCH}"
+							if [[ ${DRY_RUN} == 'true' ]]; then
+								dryRunFlag='--dry-run'
+							fi
+							git push --force ${dryRunFlag} ${pushURL} "master:refs/heads/update-build-to-R${BUILD_MAJOR}.${BUILD_MINOR}"
+							git push --force ${dryRunFlag} ${pushURL} "updateMaintenance:refs/heads/update-${MAINTENANCE_BRANCH}"
 						'''
 					}
 					script { // Create PRs agains the master and maintenance branch
@@ -284,7 +299,10 @@ pipeline {
 		}
 		stage('Stage to Maven-Central') {
 			when {
-				environment name: 'DL_TYPE', value: 'R'
+				allOf {
+					environment name: 'DL_TYPE', value: 'R'
+					not { expression { params.DRY_RUN } }
+				}
 			}
 			steps {
 				build job: 'Releng/deployToMaven', wait: true, propagate: true, parameters: [
@@ -293,16 +311,20 @@ pipeline {
 			}
 		}
 		stage('Update acknowledgements') {
+			when {
+				not { expression { params.DRY_RUN } }
+			}
 			steps {
 				script {
 					githubAPI.triggerWorkflow('eclipse-platform/www.eclipse.org-eclipse', 'generateAcknowledgements.yml', [ 'eclipse-version': "${BUILD_MAJOR}.${BUILD_MINOR}" ])
 				}
 			}
 		}
-		stage('Trigger publication') {
+		stage('Publish promoted build') {
 			when {
-				not {
-					environment name: 'DL_TYPE', value: 'R'
+				allOf {
+					not { environment name: 'DL_TYPE', value: 'R' }
+					not { expression { params.DRY_RUN } }
 				}
 			}
 			steps {
@@ -321,7 +343,7 @@ pipeline {
 
 def renameBuildDrop(String baseDropPath, String oldDropID, String oldBuildLabel, String newDropID, String newBuildLabel, Closure extraTasks=null) {
 	def sourcePath="${EP_ROOT}/${baseDropPath}/${oldDropID}"
-	def targetPath="${EP_ROOT}/${baseDropPath}/${newDropID}"
+	def targetPath="${EP_ROOT}/${DRY_RUN_PREFIX}${baseDropPath}/${newDropID}"
 
 	sh """#!/bin/bash -xe
 
@@ -386,7 +408,7 @@ EOF
 		# Copy locally modified files to the download server
 		scp -r . [email protected]:${targetPath}/
 
-		if [[ '${DL_TYPE}' == 'R' ]]; then
+		if [[ '${DL_TYPE}' == 'R' ]] && [[ '${DRY_RUN}' == 'false' ]]; then
 			echo 'Creating archive'
 			ssh [email protected] cp -r '${targetPath}' /home/data/httpd/archive.eclipse.org/${baseDropPath}/
 		fi

JenkinsJobs/shared/githubAPI.groovy

@@ -1,6 +1,6 @@
 
 @groovy.transform.Field
-def boolean IS_DRY_RUN = false
+def boolean IS_DRY_RUN = true
 
 def setDryRun(boolean isDryRun) {
 	IS_DRY_RUN = isDryRun