Release Process - SAP-archive/xsk GitHub Wiki

Release Process

Pre-release

Triggering the Pre-release action is useful for test & development purposes.

Note: The output artefacts (Docker images, Buildpacks and Helm charts) will be overridden by the Release action. No other release artefacts are published (*.jar, *.war, Release Notes, etc.).

1. Pull the latest changes:

   git pull
   

2. Trigger the GitHub Pre-release action:

   git tag pre1.0.0
   git push origin pre1.0.0
   

3. Drop the pre-release tag

   git tag -d pre5.4.0
   git push --delete origin pre5.4.0
   

Stage release

Can be trigger:

1. When you trigger Pre-release - this will deploy to Stage release the last code version from main branch.
2. From Github Actions -> Stage-release -> Run workflow -> type XSK version - this will deploy to Stage release version which is already build.

Release

1. Create branch for Pull Request:

   git pull
   git checkout -b update-release-version
   

2. Change Version for Release:

   mvn versions:set -DnewVersion=1.0.0
   git add .
   git commit -m "version set to 1.0.0 for release"
   git push --set-upstream origin update-release-version
   

3. Create Pull Request

   To open new Pull Request, go to: https://github.com/SAP/xsk/pull/new/update-release-version

   Note: Wait for the Pull Request to be merged, before triggering the Release action.

   git checkout main
   git pull
   git branch -D update-release-version
   

4. Trigger GitHub Release Action:

   git tag v1.0.0
   git push origin v1.0.0
   

   Note: Check https://status.maven.org/ before triggering the release! There could be a maintenance going on during the build, if that's the case, usually the Publish packages to Maven Central step will fail with 405 Not Allowed.

5. Create branch for Pull Request:

   git pull
   git checkout -b update-development-version
   

6. Change Version for Development:

   mvn versions:set -DnewVersion=2.0.0-SNAPSHOT
   git add .
   git commit -m "version set to 2.0.0-SNAPSHOT for Development"
   git push --set-upstream origin update-development-version
   

7. Create Pull Request

   To open new Pull Request, go to: https://github.com/SAP/xsk/pull/new/update-development-version

   git checkout main
   git branch -D update-development-version
   

How-to

Delete Tag:

git tag -d v1.0.0
git push --delete origin v1.0.0