Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Create a release branch 
    1. Clone fresh repository copy

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


    2. Checkout master branch

      Code Block
      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.

      Code Block
      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"

      Code Block
      git checkout -b branch-X.Y.Z
      


    5. 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.

    6. RM should update the year of the file "NOTICE.txt".

    7. Remove -SNAPSHOT from the release branch and commit

      Code Block
      mvn versions:set -DnewVersion=X.Y.Z -DgenerateBackupPoms=false
      git add .
      git commit -m "SENTRY-XXXX: Removing -SNAPSHOT from X.Y release branch"


    8. Check your changes and push new branch to Apache repository. "repository name" is the name of the repository, for example "origin". 

      Code Block
      mvn -U clean package -Pdownload-hadoop -Pdist -s <settings.xml>
      git push <repository name> origin branch-X.Y.Z
      


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

  2. Prepare the master for next release (TODO: update change log?)

    Code Block
    git checkout master
    mvn versions:set -DnewVersion=<X.Y.Z+1>-SNAPSHOT -DgenerateBackupPoms=false
    git add .
    git commit -m "SENTRY-XXXX: Preparing for sentry <Release name> development"
    git push origin master:master


  3. Send an email announcing new branch

     

    No Format
    To: dev@sentry.apache.org
    Subject: New sentry release branch-X.Y
    
    
    I've just created new release branch for upcoming <Release name> release.
    Please continue committing to master branch as usual.
    I'll cherry-pick commits to branch-X.Y on per needed basis.
    
    
    Thanks,
    $RM


...

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

3. You can immediately verify your signature

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

4. Create sha1 sha512 check sum as sha1 is no longer safe

Code Block
for file in *.tar.gz; do sha1sumsha512sum $file > $file.shasha512; done

Upload artifacts

Upload artifacts and all created check sums with signatures to httpssignatures 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:

 

...

1. Install svn client "yum install subversion" more details in https://

...

tecadmin.net/install-subversion-1-8-on-centos-rhel/

2. Checkout the content from "https://dist.apache.org/repos/dist/

...

$ cd sentry-release
$ (gpg --list-sigs <KEY-ID> && gpg --armor --export <KEY-ID> ) >> KEYS
$ svn commit -m "Adding PGP public key to KEYS file" KEYS

 

dev/sentry/". Then create new branch directory, add binary files and source files. Then commit them to repository server.

Code Block
svn checkout https://dist.apache.org/repos/dist/dev/sentry/ <local path>
svn mkdir X.Y.Z
svn add <file_name> 
svn commit -m 'commit message' 


Update KEYS file

Only PMC can change the 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:

 

$ cd sentry-release
$ (gpg --list-sigs <KEY-ID> && gpg --armor --export <KEY-ID> ) >> KEYS
$ svn commit -m "Adding PGP public key to KEYS file" KEYS

 

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.:

<settings>

  <servers>

    <server>

       <id>apache.releases.https</id>

       <username><apache-username></username>

           <password><apache-password></password>

    </server>

    <server>

       <id>apache.staging.https</id>

       <username><apache-username></username>

           <password><apache-password></password>

    </server>

  </servers>

</settings>

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".  If "close" fails, repeat Step 3-5.

7. Verify via the URL that should appear after refresh that the artifacts look as expected.

8. Run vote. The detail on running vote is in section "Running the vote"

9. 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 NOTICE.txt file has right content (current 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 dev@sentry.apache.org You can close the vote after voting period expires and you accumulate sufficient votes.

Call for voting on dev list (PMC)

1. Template of the email to call for voting

a. To find the link of fixed issues, go to "https://issues.apache.org/jira/projects/SENTRY/versions", and click the version to be released. 

b. The "orgapachesentry-<id>" is from Step 6 in Section "Publishing Apache Sentry artifacts to maven central"

No Format
To: dev@sentry.apache.org
Subject: [VOTE] Release Sentry version X.Y.Z
Content:

This is the release of Apache Sentry, version X.Y.Z. 

It fixes the following issues: https://issues.apache.org/jira/projects/SENTRY/versions/12342213

Source files : https://dist.apache.org/repos/dist/dev/sentry/X.Y.Z


Maven artifacts are available: https://repository.apache.org/content/repositories/orgapachesentry-<id>

Tag to be voted on (rc#): https://git-wip-us.apache.org/repos/asf/sentry/?p=sentry.git;a=commit;h=<commit-hash-of-the-tag>
Sentry's KEYS containing the PGP key we used to sign the release:
https://people.apache.org/keys/group/sentry.asc (or http://www.apache.org/dist/sentry/KEYS for non committers)

Note that this is a source only release and we are voting on the source: tag=release-X.Y.Z, SHA=<Checksum of the last commit in the branch> (You can get the hash of the tag by doing "git rev-list release-X.Y.Z | head -n 1" )

Vote will be open for 72 hours.

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


Thanks,
$RM 

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:

No Format
To: dev@sentry.apache.org
Subject: [RESULT][VOTE] Release Sentry version X.Y.Z 
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. You must be a Jira administrator or a project administrator to do the Jira Software tasks on this page. Sentry PM should have this access.

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. Only Sentry PMC can do this.

No Format
svn co https://dist.apache.org/repos/dist/release/sentry/ sentry-release
cd sentry-release
mkdir X.Y.Z/
cp $source_to_your_artifacts X.Y.Z/
svn add X.Y.Z

svn commit -m "Add $source release"

It may take up to 24 hours for all mirrors to sync up (http://www.apache.org/dyn/closer.cgi/sentry/)

Update the website

  1. Prepare to edit the website. 

    Code Block
    svn co https://svn.apache.org/repos/asf/sentry/
    
    
    


    1. Add the release to the sentry/site/trunk/content/general/downloads.mdtext

    2. Add the release to the sentry/site/trunk/content/general/history.mdtext

    3. Commit the changes
    4. 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.
  2. Update the blog with new features.

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

...

2. Make sure you have an entry in your ~/.m2/settings.xml with id "apache.staging.https" with your Apache username + password, e.g.:

<settings>

  <servers>

    <server>

       <id>apache.releases.https</id>

       <username><apache-username></username>

           <password><apache-password></password>

    </server>

    <server>

       <id>apache.staging.https</id>

       <username><apache-username></username>

           <password><apache-password></password>

    </server>

  </servers>

</settings>

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 there are no conflicting licenses (TODO: how)

...

Running the vote

Voting has to be done on dev@sentry.apache.org You can close the vote after voting period expires and you accumulate sufficient votes.

Call for voting on dev list (PMC)

No Format
To: dev@sentry.apache.org
Subject: [VOTE] Release Sentry version 1.8.0
This is the release of Apache Sentry, version 1.8.0. 
It fixes the following issues: http://s.apache.org/VlU

Source files : https://dist.apache.org/repos/dist/dev/sentry/sentry-1.8.0/

Tag to be voted on (rc#): https://git-wip-us.apache.org/repos/asf/sentry/?p=sentry.git;a=commit;h=<commit-hash-of-the-tag>
Sentry's KEYS containing the PGP key we used to sign the release:
https://people.apache.org/keys/group/sentry.asc (or http://www.apache.org/dist/sentry/KEYS for non committers)

Note that this is a source only release and we are voting on the source: tag=release-1.2.0, SHA=5e6e34202b26d7d5bc1a41e3dd4ad0cacd123e3f (You can get the hash of the tag by doing "git rev-list release-X.Y.Z | head -n 1" )

Vote will be open for 72 hours.

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


Thanks,
$RM 

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:

No Format
To: dev@sentry.apache.org
Subject: [RESULT][VOTE] Release Sentry version X.Y.Z 
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/sentry/ and add release artifacts there.

No Format
svn co https://dist.apache.org/repos/dist/release/sentry/ sentry-release
cd sentry-release
mkdir X.Y.Z/
cp $source_to_your_artifacts X.Y.Z/
svn add X.Y.Z

...


Announce the release

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

No Format
To: announce@apache.org, dev@sentry.apache.org
Subject: [ANNOUNCE] Apache Sentry X.Y.Z released

The Apache Sentry team is happy to announce the release of version X.Y.Z. 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/sentry
The change list is available at: http://s.apache.org/VlU
We would like to thank all contributors who made the release possible.

Regards,
Sentry team

Update the website

Prepare to edit the website. 

Code Block
svn co https://svn.apache.org/repos/asf/sentry/


  1. Add the release to the sentry/site/trunk/content/general/downloads.mdtext

  2. Add the release to the sentry/site/trunk/content/general/history.mdtext

  3. Commit the changes
  4. 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.

...



The Apache Sentry team is happy to announce the release of version X.Y.Z.
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://sentry.apache.org/general/downloads.html

Sentry X.Y.Z Release Notes are available here:

https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314720&version=12343306


We would like to thank all contributors who made the release possible.

Regards,
Sentry team

Preparing Branch for Future Maintenance Release

After the release has been completed, prepare the branch for the next development cycle.

...