[incubator-baremaps] branch main updated: Improve release instructions (#758)

[bc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bchapuis pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-baremaps.git


The following commit(s) were added to refs/heads/main by this push:
     new abb5ee7e Improve release instructions (#758)
abb5ee7e is described below

commit abb5ee7e6d408eb5c7f56607a01eea45427a106b
Author: Perdjesk <Pe...@users.noreply.github.com>
AuthorDate: Wed Aug 30 17:47:22 2023 +0200

    Improve release instructions (#758)
---
 RELEASE.md | 28 +++++++++++++++-------------
 1 file changed, 15 insertions(+), 13 deletions(-)

diff --git a/RELEASE.md b/RELEASE.md
index 429f3919..8f98ea69 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -9,6 +9,7 @@
   or implied. See the License for the specific language governing permissions and limitations under
   the License.
   -->
+
 # Release instructions
 
 In order to release a new version of Apache Baremaps, follow these steps:
@@ -25,7 +26,7 @@ git push --set-upstream origin release-<version>
 - [ ] Set the release version and commit the changes:
 
 ```bash 
-mvn versions:set -DnewVersion=<version>
+./mvnw versions:set -DnewVersion=<version>
 git commit -a -m "Release Baremaps <version>"
 ```
 
@@ -41,7 +42,7 @@ git tag v<version>-rc<number>
 git push origin v<version>-rc<number>
 ```
 
-- [ ] Generate the release notes for this tag on GitHub.
+- [ ] Generate the release notes for this tag on GitHub with release ticked in order to generate a release notes.
 - [ ] Generate the artifacts:
 
 ```bash
@@ -53,17 +54,18 @@ git push origin v<version>-rc<number>
 ```bash
 svn co https://dist.apache.org/repos/dist/dev/incubator/baremaps/ baremaps-dev
 mkdir baremaps-dev/<version>-rc<number>
-cp ./baremaps-cli/target/baremaps-<version>-incubating-* baremaps-dev/<version>-rc<number>/.
+cp ./baremaps-cli/target/apache-baremaps-<version>-incubating-* baremaps-dev/<version>-rc<number>/.
 svn commit -m "Baremaps <version>-rc<number>"
 ```
 
 - [ ] Ask the community to vote for the release candidate.
-- [ ] If the release candidate is not approved by the community, commit the necessary changes, clean the git history, and go back to step 5.
+- [ ] If the release candidate is not approved by the community, commit the necessary changes, clean the git history,
+  and go back to step 5.
 - [ ] If the release candidate is approved by the community, tag the release commit with the release version:
 
 ```bash
-git tag -a v[version]
-git push origin v[version]
+git tag -a v<version>
+git push origin v<version>
 ```
 
 - [ ] Move the artifacts into the release directory with svn:
@@ -77,7 +79,7 @@ svn mv -m "Baremaps <version>" \
 - [ ] Set the version of the next iteration and commit the changes:
 
 ```bash
-mvn versions:set -DnewVersion=[next_version]-SNAPSHOT
+./mvnw versions:set -DnewVersion=<next_version>-SNAPSHOT
 git commit -a -m "Prepare for next development iteration"
 git push origin
 ```
@@ -91,15 +93,15 @@ git push origin
 Verify the GPG signature of the release artifacts:
 
 ```bash
-gpg --verify baremaps-<version>-incubating-bin.tar.gz.asc
-gpg --verify baremaps-<version>-incubating-src.tar.gz.asc
+gpg --verify apache-baremaps-<version>-incubating-bin.tar.gz.asc
+gpg --verify apache-baremaps-<version>-incubating-src.tar.gz.asc
 ```
 
 Verify the SHA512 checksum of the release artifacts:
 
 ```bash
-shasum -a 512 -c baremaps-<version>-incubating-bin.tar.gz.sha512
-shasum -a 512 -c baremaps-<version>-incubating-src.tar.gz.sha512
+shasum -a 512 -c apache-baremaps-<version>-incubating-bin.tar.gz.sha512
+shasum -a 512 -c apache-baremaps-<version>-incubating-src.tar.gz.sha512
 ```
 
 ## Vote template
@@ -149,7 +151,6 @@ Here is my vote:
 
 <release_manager_name>
 
-
 ## Announce template
 
 subject: [ANNOUNCE] Apache Baremaps <version> (incubating) released
@@ -159,7 +160,8 @@ Hello Everyone,
 The Apache Baremaps community is pleased to announce the release of Apache Baremaps 0.7.1 (incubating).
 Apache Baremaps is a toolkit and a set of infrastructure components for creating, publishing, and operating online maps.
 
-This is our first release since joining the Apache Software Foundation and an important milestone in the project's history.
+This is our first release since joining the Apache Software Foundation and an important milestone in the project's
+history.
 Thank you to everyone who contributed to this release and thank you to the mentors for their guidance and support.
 
 We are looking to grow the community and welcome new contributors.