You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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.2.0-incubating, and the following development version will become 1.3.0-incubating

Prerequisites

Policy documents

Frequently asked questions for making Apache releases are available on Releases FAQ page.

The Release Manager (RM) must go through the policy document to understand all the tasks and responsibilities of running a release.

Give a heads up

The RM should setup a timeline for release branch point.

To: dev@sentry.incubator.apache.org
Subject: Work on $release release has started

I think it's time to starting thinking about the next release, which would be Sentry $release. If others agree, I will create a tracking JIRA.
 
Would would you like to see included?
Thanks,
$RM

Sanitize JIRA

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:

project = sentry and resolution = fixed and fixVersion is empty

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.2.0'.

You can also run the following query to make sure that the issues fixed for the to-be-released version look accurate:

project = sentry and resolution = fixed and fixVersion = '1.2.0'

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

Create a release branch

1. Clone fresh repository copy

git clone https://git-wip-us.apache.org/repos/asf/incubator-sentry.git 
cd sentry

2.  Checkout master branch

git checkout master

3. Check that current HEAD points to commit on which you want to base new  release branch. Checkout particular commit if not.

git log # Check current branch history. HEAD should point to commit
that you want to be base for your release branch
git checkout abcdef123 # Check out particular commit that should be
base for release branch if -^

4. Create new release branch with name "branch-$version"

git branch branch-1.2.0

5. Push new branch to Apache repository

git push origin branch-1.2.0

6. Check that branch was correctly propagated to Apache repository.

7. Update version to your release version in all pom.xml files (.pom.xml, */pom.xml and *//pom.xml). You should be changing the version only in <parent> tag (with exception of root pom.xml file that obviously do not have a parent).

8. Check your changes by running package build

mvn package -Pdownload-hadoop

9. Commit your changes and push them to Apache repository

git commit -a -m "Changing version to 1.2.0 incubating"
git push origin branch-1.2.0

10. Send an email announcing new branch

To: dev@sentry.incubator.apache.org
Subject: New release branch 1.2.0

I've just created new release branch for upcoming 1.2.0 incubating release.
Please continue committing to master branch as usual.
I'll cherry-pick commits to branch-1.2.0 on per needed basis.

Thanks,
$RM

Update change log file

1. It's important to update changelog.txt file with all changes that went it to the release. JIRA generates list of all changes in particular release in "Release notes" section:

  • On main page click "versions" from left menu
  • Click on your version
  • There is link "Release notes" on top left corner of the context area.

2. Update CHANGELOG.txt file in branches master and branch-<your-version>.

3. It's important to keep this file up-to-date with each committed change after initial branch cut.

Create release tarballs

1. Check out release branch

git clone https://git-wip-us.apache.org/repos/asf/incubator-sentry.git 
git checkout branch-1.2.0

2. Create tag on this commit to identify precise point where the RC was generated and push this tag to main repository

git tag -a release-1.2.0-rc0 -m "Sentry 1.2.0-rc0 incubating release"
git push origin release-1.2.0-rc0

3. Create temporary directory where you'll be preparing all required artifacts

mkdir -p /tmp/sentry-release-preparations

4. Create source artifact and move it to your temporary directory

mvn clean verify package
mv dist/target/sentry-1.2.0.tar.gz /tmp/sentry-release-preparations

Update KEYS file

 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

Create signatures and check sums

1. Change your working directory to the temporal one

cd /tmp/sentry-release-preparations

2. Sing each file with your key

 for file in *.tar.gz; do gpg --armor --output $file.asc --detach-sig
$file; done

3. You can immediately verify your signature

for file in *.tar.gz; do gpg --verify $file.asc $file; done

4. Create md5 check sum

for file in *.tar.gz; do md5sum $file > $file.md5; done

5. Create sha1 check sum

for file in *.tar.gz; do sha1sum $file > $file.sha; done

6. Upload artifacts and all created check sums with signatures
to your own web-space on people.apache.org

ssh people.apache.org "mkdir -p ~/public_html/sentry-1.2.0-rc0"
scp * people.apache.org:~/public_html/sentry-1.2.0-rc0

Running the vote

Call for sentry dev list votes

Send an email to dev@ list followed by general@incubator. For example,

To: dev@sentry.incubator.apache.org
Subject: [VOTE] Release Sentry incubating version 1.2.0
This is the first incubator release of Apache Sentry, version 1.2.0-incubating. 
It fixes the following issues: http://s.apache.org/VlU

Source files : http://people.apache.org/~shreepadma/sentry-1.2.0/

Tag to be voted on (rc0): https://git-wip-us.apache.org/repos/asf/incubator-sentry/repo?p=incubator-sentry.git;a=log;h=refs/tags/release-1.2.0-rc0

Sentry's KEYS containing the PGP key we used to sign the release:
https://people.apache.org/keys/group/sentry.asc

Note that this is a source only release and we are voting on the source (tag).


Vote will be open for 72 hours.

[ ] +1 approve
[ ] +0 no opinion
[ ] -1 disapprove (and reason why)


Thanks,
$RM
 

Need 3 +1 votes from PPMC members. Additionally need 3 +1 votes from IPMC members. The vote has to be called first on the dev list. Upon receiving 3 +1s from the PPMC, the vote should be called on general@incubator.

You can close the vote after voting period expires when you accumulate sufficient votes. Example close email:

Voting is now closed and has passed with the following tally,

Binding +1s: Patrick Hunt, Arvind Prabhakar, Andrei Savu
Non binding +1s: Xuefu Zhang, Jarcec Cecho, Ashish Paliwal.

Thanks to everyone who voted! I'll continue with the rest of the release process.
 
$RM

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/incubator/sentry/ and add release artifacts there.

svn co https://dist.apache.org/repos/dist/release/incubator/sentry/ sentry-release
cd sentry-release
mkdir 1.2.0-incubating/
cp $source_to_your_artifacts 1.2.0-incubating/
svn add 1.2.0-incubating
# Optionally change KEYS file in case that you've added your key for
the first time
svn commit -m "Release 1.2.0 incubating"

Wait for 24 Hours

It may take up to 24 hours for all mirrors to sync up.

Announce the release

Send an email to announce@apache.org (the from: address must be @apache.org). For example,

To: announce@apache.org, dev@sentry.incubator.apache.org
Subject: [ANNOUNCE] Apache Sentry 1.2.0 incubating released

The Apache Sentry team is happy to announce the release of version 1.2.0-incubating from the Apache Incubator.Apache Sentry is a system to enforce fine grained role based authorization to data and metadata stored on a Hadoop cluster.
The release bits are available at: http://www.apache.org/dyn/closer.cgi/incubator/sentry
The change list is available at: http://s.apache.org/VlU
We would like to thank all contributors who made the release possible.

Disclaimer
Apache Sentry is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.


Regards,
Sentry team
  • No labels