This is an automated email from the ASF dual-hosted git repository. bchapuis pushed a commit to branch v0.7.1-rc1 in repository https://gitbox.apache.org/repos/asf/incubator-baremaps.git
commit ee786e64fc747d3f5bfb01421526a05b640af423 Author: Bertil Chapuis <[email protected]> AuthorDate: Tue Mar 7 13:57:54 2023 +0100 Add release instructions and fix minor issues --- RELEASE.md | 103 ++++++++++++++++++++++++++++++++++++++ baremaps-cli/src/assembly/src.xml | 1 + pom.xml | 7 ++- 3 files changed, 107 insertions(+), 4 deletions(-) diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..1c5094f6 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,103 @@ +# Release instructions + +In order to release a new version of baremaps, follow these steps: + +- [ ] Notify the community of the upcoming release by creating a new issue on GitHub. +- [ ] Notify the community by sending a message on the mailing list and ask to pause commits on the main branch. +- [ ] Create a new branch for the release candidate: + +```bash +git checkout -b v[version]-rc[n] +``` + +- [ ] Set the release version and commit the changes: + +```bash +mvn versions:set -DnewVersion=[version] +git commit -a -m "Release Baremaps [version]" +``` + +- [ ] Tag the commit with the release candidate version: + +```bash +git tag -a v[version]-rc[n] +``` + +- [ ] Push the branch and the tag to the remote repository: + +```bash +git push origin v[version]-rc[n] +``` + +- [ ] Generate the GPG and SHA512 signatures of the release candidate (instructions below). +- [ ] Generate the release notes and attach them to the release candidate on GitHub. +- [ ] Ask the community to vote for the release candidate. +- [ ] If the release candidate is not approved by the community, go back to step 3 and perform the necessary changes. +- [ ] Otherwise, tag the commit with the release version: + +```bash +git tag -a v[version] +git push origin v[version] +``` + +- [ ] Set the next development version and commit the changes: + +```bash +mvn versions:set -DnewVersion=[next_version]-SNAPSHOT +git commit -a -m "Prepare for next development iteration" +git push origin +``` + +- [ ] Merge the accepted release candidate branch into the main branch. +- [ ] Notify the community of the release by sending a message on the mailing list. +- [ ] Clean up all the release candidate branches and tags. + +## Signing and verifying releases with GPG + +The following command signs the release with GPG: + +```bash +gpg --no-tty --pinentry-mode loopback --batch --yes --passphrase "$GPG_PASSPHRASE" --output "baremaps-[version]-incubating-[src|bin].zip.asc" --detach-sign --armor "baremaps-[version]-incubating-[src|bin].zip" +``` + +The following command verifies the release with GPG: + +```bash +gpg --verify baremaps-[version]-incubating-[src|bin].zip.asc +``` + +## Signing and verifying releases with SHA512 + +The following command signs the release with SHA512: + +```bash +shasum -a 512 -c baremaps-[version]-incubating-[src|bin].zip.sha512 +``` + +The following command verifies the release with SHA512: + +```bash +gpg --verify baremaps-[version]-incubating-[src|bin].zip.asc +``` + +## Email template + +Hello Baremaps Community, + +This is a call for a vote to the 1st release candidate for Apache Baremaps, +version [version]-incubating. + +We request project mentors (binded) as well as all contributors (unbinded) +and users to review and vote on this incubator release. + +The commit to be voted upon: +[url] + +The full list of changes and release notes are available at: +[url] + +Best regards, + +[Release manager name] + + diff --git a/baremaps-cli/src/assembly/src.xml b/baremaps-cli/src/assembly/src.xml index 35522a9a..377dc6a2 100644 --- a/baremaps-cli/src/assembly/src.xml +++ b/baremaps-cli/src/assembly/src.xml @@ -28,6 +28,7 @@ <include>codestyle.xml</include> <include>DISCLAIMER-WIP</include> <include>LICENSE</include> + <include>LICENSE.header</include> <include>NOTICE</include> <include>README</include> </includes> diff --git a/pom.xml b/pom.xml index 3229486f..ebb0f707 100644 --- a/pom.xml +++ b/pom.xml @@ -51,10 +51,9 @@ </modules> <scm> - <connection>scm:git:[email protected]:baremaps/baremaps.git</connection> - <developerConnection>scm:git:[email protected]:baremaps/baremaps.git</developerConnection> - <tag>v0.2.3</tag> - <url>scm:git:[email protected]:baremaps/baremaps.git</url> + <connection>scm:git:[email protected]:apache/baremaps.git</connection> + <developerConnection>scm:git:[email protected]:apache/baremaps.git</developerConnection> + <url>scm:git:[email protected]:apache/baremaps.git</url> </scm> <distributionManagement>
