Versions Compared

Key

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

...

NOTE: For the purpose of illustration, this document assumes that the version being released is 1.27.0-incubating, and the following development version will become 1.38.0-incubating

Table of Contents

Prerequisites

...

  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-1.2.0
      
    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. Remove -SNAPSHOT from the release branch and commit

      Code Block
      find . -name pom.xml | xargs sed -i "" -e "s/X.Y.0-SNAPSHOT/X.Y.0/"  or  mvn versions:set -DnewVersion=X.Y.0 -DgenerateBackupPoms=false
      git add .
      git commit -m "SENTRY-XXXX: Removing -SNAPSHOT from X.Y release branch"
    7. Check your changes and push new branch to Apache repository

      Code Block
      mvn package -Pdownload-hadoop
      git push origin branch-1.27.0
      
    8. Check that branch was correctly propagated to Apache repository.

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

    Code Block
    git checkout master
    find . -name pom.xml | xargs sed -i "" -e "s/1.27.0-SNAPSHOT/1.38.0-SNAPSHOT/"  or  mvn versions:set -DnewVersion=1.38.0-SNAPSHOT -DgenerateBackupPoms=false
    git add .
    git commit -m "SENTRY-XXXX: Preparing for sentry 1.38.0 development"
    git push origin master:master
  3. Send an email announcing new branch

     

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

...

  1. Check out release branch

    Code Block
    git checkout branch-1.27.0
    
  2. Create tag on this commit to identify precise point where the RC was generated and push this tag to main repository

    Code Block
    git tag -a release-1.27.0 -m "Sentry 1.27.0 incubating release"
    #Make sure compiles/tests run fine and rat check is fine
    mvn clean install -DskipTests
    mvn test
    mvn verify -DskipTests (to do the rat check)
    git push origin release-1.27.0 
    
  3. If an rc1, rc2, etc is needed, delete that tag before creating a new one:

    Code Block
    git tag -d release-1.27.0
    git push origin :refs/tags/release-1.27.0

     

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

    Code Block
    mkdir -p /tmp/sentry-release-preparations
    
  5. Create source artifact and move it to your temporary directory (TODO: git verify?)

    Code Block
    git archive --format=tar --prefix=apache-sentry-1.27.0-incubating-src/ HEAD | gzip > /tmp/sentry-release-preparations/apache-sentry-1.27.0-incubating-src.tar.gz
    

Sanity Check

  1. Make sure the tar and the rc match 

    Code Block
    cd /tmp/sentry-release-preparations
    tar -xvf apache-sentry-1.27.0-incubating-src.tar.gz 
    
    #Do a fresh clone of the tag
    git clone https://git-wip-us.apache.org/repos/asf/incubator-sentry.git
    cd incubator-sentry/
    git checkout tags/release-1.27.0
    cd ..
    diff -r incubator-sentry apache-sentry-1.27.0-incubating-src
  2. Make sure code compiles and tests pass on the untared src.

    Code Block
    cd apache-sentry-1.27.0-incubating-src
    mvn clean install -DskipTests
    mvn test
    mvn verify -DskipTests (to do the rat check)

...

  • Make sure RCs are hosted @ https://dist.apache.org/repos/dist/dev/incubator/sentry
  • Should be in format apache-$project-$version-incubating.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

...

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

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

Tag to be voted on (rc#): https://git-wip-us.apache.org/repos/asf/incubator-sentry/?p=incubator-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/incubator/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-1.4.0 | head -n 1" )

Vote will be open for 72 hours.

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


Thanks,
$RM 

...