diff --git a/README.adoc b/README.adoc index 1cc8f10..2a601c6 100644 --- a/README.adoc +++ b/README.adoc @@ -19,4 +19,24 @@ We have separate folders for each of these: * link:affordances[Affordances] - Create richer hypermedia controls using more complex hypermedia formats NOTE: The master branch tracks Spring HATEOAS 1.0, based upon Spring Boot 2 + Spring Framework 5. -To see examples depicted against the 0.x branch (Spring 4.x) visit the https://github.com/spring-projects/spring-hateoas-examples/tree/0.x[0.x branch]. \ No newline at end of file +To see examples depicted against the 0.x branch (Spring 4.x) visit the https://github.com/spring-projects/spring-hateoas-examples/tree/0.x[0.x branch]. + +=== Making a release + +1. Create a new release (on the main branch). ++ +---- +% ci/create-release.sh +---- ++ +2. With the release tagged, push the tagged version to the release branch. ++ +---- +% git checkout -b release +% git reset --hard +% git push -f origin release +---- + +NOTE: You can chain the previous set of commands together using `&&`. + +The pipeline will build and release the "release" branch. It will also build a new a new snapshot and stage it on artifactory.