diff --git a/README.adoc b/README.adoc index d2e97fd5..4e49ed2b 100644 --- a/README.adoc +++ b/README.adoc @@ -24,9 +24,11 @@ git config core.commentchar "/" 1. Create a new release (on the main branch). + ---- -% ci/create-release.sh +% ci/create-release.sh ---- + +NOTE: Because starts with `#`, it must be prefix on the command line with `\`, e.g. `ci/create-release.sh \#123 1.0.0.M1 1.0.0.BUILD-SNAPSHOT`. ++ 2. With the release tagged, push the tagged version to the release branch. + ---- diff --git a/ci/create-release.sh b/ci/create-release.sh index bca253d2..58b3711a 100755 --- a/ci/create-release.sh +++ b/ci/create-release.sh @@ -2,13 +2,14 @@ set -euo pipefail -RELEASE=$1 -SNAPSHOT=$2 +TICKET=$1 +RELEASE=$2 +SNAPSHOT=$3 # Bump up the version in pom.xml to the desired version and commit the change ./mvnw versions:set -DnewVersion=$RELEASE -DgenerateBackupPoms=false git add . -git commit --message "Releasing Spring HATEOAS v$RELEASE" +git commit --message "$ISSUE - Releasing Spring HATEOAS v$RELEASE." # Tag the release git tag -s v$RELEASE -m "v$RELEASE" @@ -16,6 +17,6 @@ git tag -s v$RELEASE -m "v$RELEASE" # Bump up the version in pom.xml to the next snapshot ./mvnw versions:set -DnewVersion=$SNAPSHOT -DgenerateBackupPoms=false git add . -git commit --message "Continue development on v$SNAPSHOT" +git commit --message "$ISSUE - Continue development on v$SNAPSHOT."