diff --git a/README.adoc b/README.adoc index 638821d..573df50 100644 --- a/README.adoc +++ b/README.adoc @@ -14,4 +14,24 @@ We have separate folders for each of these: * link:basics[Basics] - Poke and prod at a hypermedia-powered service from inside the code as well as externally using standard tools * link:api-evolution[API Evolution] - Upgrade an existing REST resource -* link:hypermedia[Hypermedia] - Create hypermedia-driven REST resources, linking them together, and supporting older links. \ No newline at end of file +* link:hypermedia[Hypermedia] - Create hypermedia-driven REST resources, linking them together, and supporting older links. + +=== 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-0.x +% git reset --hard +% git push -f origin release-0.x +---- + +NOTE: You can chain the previous set of commands together using `&&`. + +The pipeline will build and release the "release-0.x" branch. It will also build a new a new snapshot and stage it on artifactory.