{% include toc %}
This is a guide to make a released version of Apache RocketMQ. Please follow the steps below:
The release documentations provided by The ASF can be found here:
Create a code signing gpg key for release signing, use <your Apache ID>@apache.org as your primary ID for the code signing key. See Apache Release Signing documentation for more details.
gpg --full-generate-key
, and answer 4096 bits with no expiration time.gpg --keyserver pgpkeys.mit.edu --send-key <your key id>
.gpg --armor --export <your key id> >> gpgapachekey.txt
.Tips: If you have more than one key in your gpg, set the code signing key to ~/.gnupg/gpg.conf
as default key is recommended.
Make sure your Maven settings.xml file contains the following:
<settings> <profiles> <profile> <id>signed_release</id> <properties> <mavenExecutorId>forked-path</mavenExecutorId> <gpg.keyname>yourKeyName</gpg.keyname> <deploy.url>https://dist.apache.org/repos/dist/dev/rocketmq/</deploy.url> </properties> </profile> </profiles> <servers> <!-- To publish a snapshot of some part of Maven --> <server> <id>apache.snapshots.https</id> <username>yourApacheID</username> <password>yourApachePassword</password> </server> <!-- To stage a release of some part of Maven --> <server> <id>apache.releases.https</id> <username>yourApacheID</username> <password>yourApachePassword</password> </server> <server> <id>gpg.passphrase</id> <passphrase>yourKeyPassword</passphrase> </server> </servers> </settings>
Tips: It is highly recommended to use Maven's password encryption capabilities for your passwords.
Cleanup JIRA issues or Github Issues related to this release version, and check all the issues has been marked with right version in the FixVersion
field.
Also, remember to check the current version of MQVersion, which should be equal to this released version.
Generate the release notes via RocketMQ JIRA and publish it to the rocketmq-site, there is a release notes available for reference, include the link to the release notes in the voting emails.
In this process, you need to use maven release plugin to release the artifact to maven repository. And also, copy them to the svn repository.
Remember to check the current version of MQVersion again, which should be equal to this released version like release-4.5.0
.
public static final int CURRENT_VERSION = Version.V4_5_0.ordinal();
Make sure that you are in the develop branch, and Github PRs related to this release version are merged. Perform the following to generate and stage the artifacts:
mvn clean release:clean
mvn release:prepare -Psigned_release -Darguments="-DskipTests"
, answer the correct release version(use the default, the version in pom, just enter), SCM release tag(use the default, the branch name, just enter), and the new development version(increate the version by 1.0, if you release 4.2.0, then the next version should be 4.3.0).mvn -Psigned_release release:perform -Darguments="-DskipTests"
, generate the artifacts and push them to the Nexus repo. If you would like to perform a dry run first (without pushing the artifacts to the repo), add the arg -DdryRun=true.Now, the candidate release artifacts can be found in the Nexus staging repo and in the target
folder of your local branch.
Tips: If you are performing a source-only release, please remove all artifacts from the staging repo besides the .zip file containing the source and the javadocs jar file. In the Nexus GUI, you can right click on each artifact to be deleted and then select Delete
.
Checkout a new branch from the target branch(master or develop) according to the release tag with its name equal to the release version, like release-4.5.0
.
If the staging process encounter problem, you may need to rollback: Delete the branch and tag created in 2.1 and then redo it.
Checkout the code to be released(must be the same as the source branch), and build the binary artifact. Be aware of the os version, for some dependency is os sensitive, such as netty tc-native.
mvn clean install
.mvn clean test -Pit-test
.After the successful building, remember to sign the artifact(PGP and SHA512 signatures are required), and copy them to the svn repository, you could refer to svn repository .
Please follow the steps below to verify the checksums and PGP signatures:
for file in `find . -type f -iname '*.asc'` do gpg --verify ${file} done
or
gpg --verify rocketmq-all-%version-number%-source-release.zip.asc rocketmq-all-%version-number%-bin-release.zip
Check the output to ensure it only contains good signatures:
gpg: Good signature from ... gpg: Signature made ...
gpg --print-md SHA512 rocketmq-all-%version-number%-source-release.zip gpg --print-md SHA512 rocketmq-all-%version-number%-bin-release.zip
If the release candidate passes the validation checklist, close the staging repository in Nexus by selecting the staging repository orgapacherocketmq-XXX
and clicking on the Close
icon.
Nexus will now run through a series of checksum and signature validations.
If the checks are passed, Nexus will close the repository and produce a URL to the closed staging repo (which contains the candidate artifacts). Include this URL in the voting email so that folks can find the staged candidate release artifacts.
If the checks aren't passed, fix the issues then go back and restart the release process.
If everything is ok, use svn to copy the candidate release artifacts to RocketMQ repo: https://dist.apache.org/repos/dist/dev/rocketmq/${release-version}.
Release voting must successfully pass within the Apache RocketMQ community via the dev@rocketmq.apache.org mailing list.
General information regarding the Apache voting process can be found here.
To vote on a candidate release, send an email to the dev list with subject [VOTE]: Release Apache RocketMQ <release-version> RC<RC Number> and body:
Hello RocketMQ Community,
This is the vote for <release version> of Apache RocketMQ.
${A brief introduction to RocketMQ and the features of this release.}The artifacts:
https://dist.apache.org/repos/dist/dev/rocketmq/${release version}The staging repo:
https://repository.apache.org/content/repositories/orgapacherocketmq-XXX/Git tag for the release:
<link to the tag of GitHub repo>Hash for the release tag:
<Hash value of the release tag>Release Notes:
<insert link to the rocketmq release notes>The artifacts have been signed with Key : <ID of signing key>, which can be found in the keys file:
https://dist.apache.org/repos/dist/dev/rocketmq/KEYSThe vote will be open for at least 72 hours or until necessary number of votes are reached.
Please vote accordingly:
[ ] +1 approve
[ ] +0 no opinion
[ ] -1 disapprove with the reasonThanks,
The Apache RocketMQ Team
Once 72 hours has passed (which is generally preferred) and/or at least three +1 (binding) votes have been cast with no -1 (binding) votes, send an email closing the vote and congratulate the release candidate. Please use the subject: [RESULT][VOTE]: Release Apache RocketMQ <release-version> RC<RC Number> :
Hello RocketMQ Community,
The Apache RocketMQ vote is now closed and has passed with [number] binding +1s, [number] non-binding +1s and no 0 or -1:
Binding votes +1s:
User Name (Apache ID)
User Name (Apache ID)
User Name (Apache ID)
....Non-binding votes +1s:
User Name (Apache ID)
....The release will be published soon.
Thanks,
The Apache RocketMQ Team
If we do not pass the VOTE, fix the related issues, go back, restart the release process and increase RC number. When we call a new vote, we must use the updated mail subject: [RESTART][VOTE][#<Attempt Number>]: Release Apache RocketMQ <release-version> RC<RC Number>
Once the Apache RocketMQ PPMC votes pass, publish the release artifacts to the Nexus Maven repository and to the Apache release repository.
Release
icon.Send an email to announce@apache.org, users@rocketmq.apache.org, private@rocketmq.apache.org, and dev@rocketmq.apache.org with the subject [ANNOUNCE] Release Apache RocketMQ <release-version> and a body along the lines of:
Hi all,
The Apache RocketMQ team would like to announce the release of Apache RocketMQ <release version>.
${A brief introduction to RocketMQ and the features of this release.}
More details regarding Apache RocketMQ can be found at:
http://rocketmq.apache.org/The release artifacts can be downloaded here:
https://dist.apache.org/repos/dist/release/rocketmq/${release-version}The release notes can be found here:
<insert link to the rocketmq release notes>Thanks,
The Apache RocketMQ Team