Skip to content

Latest commit

 

History

History
198 lines (136 loc) · 6.07 KB

RELEASE.md

File metadata and controls

198 lines (136 loc) · 6.07 KB
Raw

Release instructions

In order to release a new version of Apache Baremaps, follow these steps:

  • Notify the mailing list and ask everyone to pause commits on the main branch
  • Create a new issue on GitHub with the title "Release Baremaps "
  • Create a new branch for the release (e.g. release-<version>)
cd baremaps
git checkout -b release-<version>
git push --set-upstream origin release-<version>
  • Set the release version and commit the changes:
./mvnw versions:set -DnewVersion=<version>
git commit -a -m "Release Baremaps <version>"
  • Tag the last commit with the release candidate version:
git tag v<version>-rc<number>
  • Push the tag to the remote repository:
git push origin v<version>-rc<number>
  • Generate the release notes for this tag on GitHub with release ticked in order to generate a release notes.
  • Generate the artifacts:
./scripts/generate-artifacts.sh
  • Publish the artifacts:
cd ..
svn co https://dist.apache.org/repos/dist/dev/incubator/baremaps/ baremaps-dev
mkdir baremaps-dev/<version>-rc<number>
cp ./baremaps/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 approved by the community, tag the release commit with the release version:
git tag -a v<version>
git push origin v<version>
  • Move the artifacts into the release directory with svn:
svn mv -m "Baremaps <version>" \
  https://dist.apache.org/repos/dist/dev/incubator/baremaps/<version>-rc<number>/ \
  https://dist.apache.org/repos/dist/release/incubator/baremaps/<version>/
  • Set the version of the next iteration and commit the changes:
./mvnw versions:set -DnewVersion=<next_version>-SNAPSHOT
git commit -a -m "Prepare for next development iteration"
git push origin
  • Rebase the release branch into the main branch.
  • Notify the community of the release by sending a message to the mailing list.
  • Clean up all the release candidate branches and tags.

Verifying the release artifacts

Verify the GPG signature of the release artifacts:

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:

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

subject: [VOTE] Release Apache Baremaps -rc (incubating)

Hello Everyone,

I have created a build for Apache Baremaps (incubating) , release candidate .

Thanks to everyone who has contributed to this release.

You can read the release notes here: https://github.com/apache/incubator-baremaps/releases/tag/v-rc

The commit to be voted upon: https://github.com/apache/incubator-baremaps/tree/v-rc

Its hash is .

Its tag is v-rc.

The artifacts to be voted on are located here: https://dist.apache.org/repos/dist/dev/incubator/baremaps/-rc/

The hashes of the artifacts are as follows:

Release artifacts are signed with the following key: http://people.apache.org/keys/committer/.asc https://downloads.apache.org/incubator/baremaps/KEYS

The README file for the src distribution contains instructions for building and testing the release.

Please vote on releasing this package as Apache Baremaps .

The vote is open for the next 72 hours and passes if a majority of at least three +1 PMC votes are cast.

[ ] +1 Release this package as Apache Baremaps [ ] 0 I don't feel strongly about it, but I'm okay with the release [ ] -1 Do not release this package because...

Here is my vote:

+1 (binding)

<release_manager_name>

Announce template

subject: [ANNOUNCE] Apache Baremaps (incubating) released

Hello Everyone,

The Apache Baremaps community is pleased to announce the release of Apache Baremaps (incubating). Thank you to everyone who contributed to this release.

Apache Baremaps is a toolkit and a set of infrastructure components for creating, publishing, and operating online maps.

The release notes are available here: https://github.com/apache/incubator-baremaps/releases/tag/v

The download page is located here: https://baremaps.apache.org/download/release-

We are looking to grow our community and welcome new contributors. If you are interested in contributing to the project, please contact us on the mailing list or on GitHub. We will be happy to help you get started.

The repository is available here: https://github.com/apache/incubator-baremaps

The documentation is available here: https://baremaps.apache.org

The mailing list is available here: https://lists.apache.org/[email protected]

The issue tracker is available here: https://github.com/apache/incubator-baremaps/issues

Best regards,

<release_manager_name>