This document describes how to release Sentry. It is a work in progress and should be refined by the Release Manager (RM) as they come across aspects of the release process not yet documented here.
NOTE: This document outlines how to do a source only release. Releasing and publishing binary artifacts requires steps that are not outlined here.
NOTE: For the purpose of illustration, this document assumes that the version being released is 1.8.0, and the following development version will become 2.0.0
Frequently asked questions for making Apache releases are available on Releases FAQ page. Release Process guide also has good information on best practices for releasing artifacts from an Apache project.
The Release Manager (RM) must go through the policy document to understand all the tasks and responsibilities of running a release.
Formal DISCUSS thread
We need to send out an email to dev@ proposing a release and reference this thread in the heads up email(see below)
Release name: (Major.Minor.Patch)
Branch name: (Major.Minor)
Give a heads up
The RM should first create an umbrella issue and then setup a timeline for release branch point. The time for the day the umbrella issue is created to the release branch point must be at least two weeks in order to give the community a chance to prioritize and commit any last minute features and issues they would like to see in the upcoming release.
The RM should then send the pointer to the umbrella issue along with the tentative timeline for branch point to the developer lists (TODO: Also send to users list once we create one). Any work identified as release related that needs to be completed should be added as a subtask of the umbrella issue to allow users to see the overall release progress in one place.
Before a release is done, make sure that any issues that are fixed have their fix version setup correctly. Run the following JIRA query to see which resolved issues do not have their fix version set up correctly:
The result of the above query should be empty. If some issues do show up in this query that have been fixed since the last release, please bulk-edit them to set the fix version to '1.8.0'.
Move the unresolved jiras to the next release
You can also run the following query to make sure that the issues fixed for the to-be-released version look accurate:
Finally, check out the output of the JIRA release note tool to see which JIRAs are included in the release, in order to do a sanity check.
Monitor active issues
It is important that between the time the intent to release email is sent and the release branch is created, no experimental or potentially destabilizing work is checked into the trunk. While it is acceptable to introduce major changes, they must be thoroughly reviewed and have good test coverage to ensure that the release branch does not start of being unstable.
If necessary the RM can discuss if certain issues should be fixed on the trunk in this time, and if so what is the gating criteria for accepting them.
Creating Release Artifacts
Communicate with the community
- Send an email to dev list to
Notify that you are about to branch. Ask to hold off any commits until this is finished.
- Send another email after branching is done.
- Create a release branch
Clone fresh repository copy
Checkout master branch
Check that current HEAD points to commit on which you want to base new release branch. Checkout particular commit if not.
Create new release branch with name "branch-$version"
Update CHANGELOG in the trunk to indicate the changes going into the new version.
The change list can be swiped from the JIRA release note tool (use the "text" format for the change log). See JIRA Cleanup above to ensure that the release notes generated by this tool are what you are expecting.
Remove -SNAPSHOT from the release branch and commit
Check your changes and push new branch to Apache repository
Check that branch was correctly propagated to Apache repository.
Prepare the master for next release (TODO: update change log?)
- Send an email announcing new branch
Create release tar balls
Check out release branch
Create tag on this commit to identify precise point where the RC was generated and push this tag to main repository
If an rc1, rc2, etc is needed, delete that tag before creating a new one:
Create temporary directory where you'll be preparing all required artifacts
Create source artifact and move it to your temporary directory (TODO: git verify?)
Make sure the tar and the rc match
Make sure code compiles and tests pass on the untared src.
Create signatures and check sums (TODO: Use maven gpg plugin?)
All artifacts must be signed and checksummed. In order to sign a release you will need a PGP key. You should get your key signed by a few other people. You will also need to recv their keys from a public key server. See the Apache release signing page for more details. If you add your PGP key fingerprint to your Apache profile, your key should automatically be added to https://people.apache.org/keys/group/sentry.asc
1. Change your working directory to the temporal one
2. Sing each file with your key
3. You can immediately verify your signature
4. Create sha1 check sum
Upload artifacts and all created check sums with signatures to https://dist.apache.org/repos/dist/dev/sentry
Update KEYS file
If your PGP key is not yet in the project's KEYS file, you need to first add that in. To do this, checkout the KEYS file and update it using the following commands:
Once this file has been updated, you need to publish it in the appropriate dist directory for the project on
http://www.apache.org/dist. To do this, you must copy the file as follows:
This will take some time to propagate in which you can continue with the other steps of the release process.
Publishing Apache Sentry artifacts to maven central
1. Checkout the relevant git tag, e.g. git checkout release-1.8.0
2. Make sure you have an entry in your ~/.m2/settings.xml with id "apache.staging.https" with your Apache username + password, e.g.:
3. Deploy the release with: mvn clean deploy -Psign-artifacts
4. Go to https://repository.apache.org/ and log in using your Apache username + password.
5. Click on "Staging Repositories" on the left hand side.
6. Select the entry that starts with orgapachesentry and click on "close".
7. Verify via the URL that should appear after refresh that the artifacts look as expected.
8. After approval, click on "release".
Verifying a release candidate
Following are the typical things we need to verify before voting on a release candidate. And the release manager should verify them too before calling out a vote.
- Make sure RCs are hosted @ https://dist.apache.org/repos/dist/dev/sentry
- Should be in format apache-$project-$version.tar.gz
- Verify Signatures and hashes. You may have to import the public key of the release manager to verify the signatures. (gpg --recv-key <last8 of public key>)
- git tag matches the released bits (diff -rf)
- Can compile successfully from source
- Verify DISCLAIMER, NOTICE and LICENCE (year etc)
- All files have correct headers (Rat check should be clean - mvn verify)
- Make sure there are no conflicting licenses (TODO: how)
- No jar files or the like in the release
Running the vote
Voting has to be done on firstname.lastname@example.org You can close the vote after voting period expires and you accumulate sufficient votes.
Call for voting on dev list (PMC)
The vote has to be called on the dev list. Upon receiving 3 +1s from the PMC, reply to the voting thread and prefixing [RESULT] to the subject line with the results.
Example close email:
Rolling out the Release
Close JIRA version
You need to close the release in JIRA so that everyone knows that your version should not be used as "fixVersion" for new bugs. Go to JIRA "Administer project" page and follow "Versions" in left menu. Table with list of all releases should appear, click on additional menu on the right of your release and choose "Release" option. Submit release date and you're done.
Upload the artifacts
In order to release you have to checkout release repository located on https://dist.apache.org/repos/dist/release/sentry/ and add release artifacts there.
It may take up to 24 hours for all mirrors to sync up (http://www.apache.org/dyn/closer.cgi/sentry/)
Update the website
Prepare to edit the website.
Add the release to the sentry/site/trunk/content/general/downloads.mdtext
Add the release to the sentry/site/trunk/content/general/history.mdtext
- Commit the changes
- Go to https://cms.apache.org/sentry/ get the sentry working copy, force a new copy if you don't see your changes yet, and then ask it to publish the new copy. That should update the downloads and history page as per the changes you made to downloads.mdtext, history.mdtext earlier. If you don't see it yet, you may have to wait 24 hours - it should be there by then.
- Update the blog with new features.
Announce the release
Preparing Branch for Future Maintenance Release
After the release has been completed, prepare the branch for the next development cycle.
Check out the release branch with:
git clone https://git-wip-us.apache.org/repos/asf/sentry.git
git checkout branch-X.Y
versionproperty value in all pom.xml files and add the
SNAPSHOTsuffix. For example, if the released version was
0.7.0, the new value should be
0.7.1-SNAPSHOT. Please note that the
SNAPSHOTsuffix is required in order to indicate that this is an unreleased development branch. Use Maven's Versions plugin to do this as follows:
mvn versions:set -DnewVersion=0.7.1-SNAPSHOT -DgenerateBackupPoms=false
- Verify that the build is working with changes.
Commit these changes with a comment "Preparing for X.Y.Z+1 development".