[incubator-baremaps] 01/02: Add release instructions

[bc...@apache.org]

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

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

commit 54696abc6e0ea54caac9ceb0a11a4d1dfc5f1b2d
Author: Bertil Chapuis <bc...@gmail.com>
AuthorDate: Tue Mar 7 13:57:54 2023 +0100

    Add release instructions
---
 RELEASE.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 00000000..564552ff
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,19 @@
+# Release instructions
+
+In order to release a new version of baremaps, follow these steps:
+
+1. Notify the community of the upcoming release by creating a new issue on GitHub.
+2. Notify the community by sending a message on the mailing list and ask to pause commits on the main branch.
+3. Create a new branch for the release.
+4. Create a release candidate by running the following command:
+
+```bash 
+mvn release:prepare -DautoVersionSubmodules=true -DgenerateBackupPoms=false
+```
+
+5. Set the release version (e.g. 1.0.0).
+6. Set the tag name (e.g. v1.0.0-rc1).
+7. Set the next development version (e.g. 1.0.1-SNAPSHOT).
+8. Ask the community to test the release candidate.
+9. If the release candidate is not approved by the community, perform the necessary changes and go back to step 4.
+10. If the release candidate is approved by the community, rename the tag (e.g. v1.0.0), push it to the main branch, generate the release notes on GitHub, and notify the community.