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

Compare with Current View Page History

« Previous Version 38 Next »

Currently, this is just a collection area for my rough notes and what-not.  It will soon be a much cleaner guide.

 

Speaking of guides, here are a bunch of good ones:

http://accumulo.apache.org/releasing.html
http://accumulo.apache.org/verifying_releases.html

http://yetus.apache.org/contribute/releases/

How to Release Sqoop2

 

The purpose of this page is to document the mechanics of a release.  I took this phrase from the NiFi Release Guide (http://nifi.apache.org/release-guide.html) because I really like their outline and guide.  Eventually, we should incorporate other aspects into this guide including:

Background Material

What to validate and how to Validate a release

The flow of a release (an outline)

 

(Feel free to toss in any additional sections here)


The mechanics of the release  

Release Manager Dependencies

Before a Release Manager begins cutting a release of Apache Rya, there are a handful of Dependencies and Prerequisites they need to satisfy:

  1. They need to be a Rya Commiter

    As a Rya Commiter, the Release Manager will have access to several really important tools used throughout the release process.   This includes write access to the official Apache Rya Git Repo, the Apache Jenkins Server, and the Apache Nexus Server.

  2. Checkout and Build Rya

    The Release Manager should verify that they can checkout, build, and test Apache Rya on their machine.

    1. Checkout code from Git 

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

    2. Build and Test Apache Rya

      mvn clean install
  3. Setting up a PGP Key

    The Release manager needs a PGP Key and this key needs to be public.  The first two items listed here need to be done (i.e. get some software to create a key, and create a key).  I'm not sure about the last three.
    1. Getting software

      1. Use gpg-agent, and be sure to increase the gpg-agent cache timeout (via .gnupg/gpg-agent.conf) to ensure that the agent doesn’t require re-authentication mid-build, as it will cause things to fail. For example, you can add default-cache-ttl 6000 to increase the timeout from the default of 10 minutes to over an hour. If you do not have a GPG key, reference the very thorough ASF release signing documentation. make sure you reset gpg-agent:

        echo RELOADAGENT | gpg-connect-agent
    2. Creating a key
    3. Publishing a key to a public server
    4. Adding your key to id.apache.org
  4. Setting up Maven to push to apache repo
    1. Username/pass in maven settings
  5. Add Key to KEYS file
    1. https://dist.apache.org/repos/dist/release/incubator/rya/KEYS
  6. Testing settings
    1. Testing locally: 
      1. mvn clean install -Papache-release

    2. Testing by pushing to apache snapshot repo

      1. mvn clean deploy -Papache-release

Staging a release (super short edition):

1.Checkout out code
2. Create release candidate branch from master.  Name the branch <releaseVersion>-RC<N>

 

git checkout -b 3.2.10-RC2 master

 

3. Build Rya, prepare and perform release

 

mvn clean release:prepare -Darguments="-DskipTests"

 

 

What is the release version for "Apache Rya Project"? (org.apache.rya:rya-project) 3.2.10-incubating: : 
What is SCM release tag or label for "Apache Rya Project"? (org.apache.rya:rya-project) v3.2.10-incubating: : rya-incubating-3.2.10-rc2
What is the new development version for "Apache Rya Project"? (org.apache.rya:rya-project) 3.2.11-incubating-SNAPSHOT: :

 

 

mvn release:perform -Darguments="-DskipTests"

 

add the artifacts to dist

svn checkout https://dist.apache.org/repos/dist/dev/incubator/rya
(double check that last command)
mkdir rya-incubating-3.2.10-rc3
cd rya-incubating-3.2.10-rc3
 
cp ../../incubator-rya-apache/target/checkout/target/rya-project-3.2.10-incubating-source-release.zip.* .
md5 -r rya-project-3.2.10-incubating-source-release.zip > rya-project-3.2.10-incubating-source-release.zip.md5
shasum -a 1 rya-project-3.2.10-incubating-source-release.zip > rya-project-3.2.10-incubating-source-release.zip.sha1
 
cd ..
 
svn add rya-incubating-3.2.10-rc3
svn commit -m "Adding rya-incubating-3.2.10-rc3"

add your keys to KEYS (this is a pre-req)

 

Once the release has been performed, the artifacts should be in a staging repository:
From "Publishing Maven Artifacts" page:
Now you must close the staging repository to indicate to Nexus that the build is done and to make the artifacts available. Follow the steps in Closing the Staged Repositoryto close your new repository, this will allow your community to VOTE on the staged artifacts.

Download the src artifact and performs some simple tests:

  • Download the sources and verify they compile cleanly.
  • Validate the hashes match.
  • Validate that the sources contain no unexpected binaries.
  • Validate the signature for the build and hashes.
  • Validate the LICENSE/NOTICE/Headers.

 Other release checklists:

http://wiki.apache.org/incubator/ReleaseChecklist

http://incubator.apache.org/guides/releasemanagement.html#check-list


how to verify hashes:

https://www.openoffice.org/download/checksums.html


Commands to build Rya with a Fresh Maven Repo and Settings.xml
rm DEPENDENCIES
mkdir /tmp/new_m2
cp $M2_HOME/conf/settings.xml /tmp/new_m2/settings.xml
mvn --settings /tmp/new_m2settings.xml -Dmaven.repo.local=/tmp/new_m2 clean package

 

 

Command to Check for Binary Files
find . -type f  | grep -v '\/test\/\|\/site\/\|\.java\|\.xml\|\.xsl\|\.groovy\|\.properties\|\.sh\|\.bat\|\.md\|\.txt'

 

 

Find large files
find . -type f | xargs du -sh | grep [GM]\\s

 

Send out a Vote email (make sure to include some sort of "RC-X" identifier in the vote subject so that we can differentiate them in the archives) TODO: Add Time Stamp for the Vote to end

To: dev@rya.incubator.apache.org
Subject: [VOTE] Release Rya (Incubating) version 3.2.10 RC1

I am pleased to be calling this vote for the source release of Apache Rya (Incubating), version 3.2.10.
 
The source zip, including signatures, digests, etc. can be found at:
https://dist.apache.org/repos/dist/dev/incubator/rya/rya-incubating-3.2.10-rc2/

Ancillary artifacts such as poms, jars, wars, ect. can be found here:
https://repository.apache.org/content/repositories/orgapacherya-1002/org/apache/rya/rya-project/3.2.10-incubating/

The Git tag is rya-incubating-3.2.10-rc2
The Git commit ID is 9f0d63e6089df172eb3f41957d2956ec0035953a
https://git-wip-us.apache.org/repos/asf?p=incubator-rya.git;a=commit;h=9f0d63e6089df172eb3f41957d2956ec0035953a
 
Checksums of rya-project-3.2.10-source-release.zip:
SHA1: 5f91b695e5bebfa89eee27debfca7a264f81f888
MD5: 5199aee4ca11e3c735f6e8b40f563f09
 
Release artifacts are signed with the following key:
https://people.apache.org/keys/committer/mihalik.asc

KEYS file available here:
https://dist.apache.org/repos/dist/release/incubator/rya/KEYS
 
Issues that were closed/resolved for this release are here:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12334209&styleName=Html&projectId=12319020
 
Issues resolved between RC1 and RC2 are here:
https://issues.apache.org/jira/browse/RYA-184

The vote will be open for 72 hours and close at <Date Time and Timezone>.
Please download the release candidate and evaluate the necessary items including checking hashes, signatures, build from source, and test.  The please vote:
 
[ ] +1 Release this package as rya-project-3.2.10
[ ] +0 no opinion
[ ] -1 Do not release this package because because...




To: dev@rya.incubator.apache.org
Subject: [RESULT] [VOTE] Release Rya (Incubating) version 3.2.10 RC1

Hello,

The vote to release Rya (Incubating) version 3.2.10 RC1 has passed/failed.

+1 (binding):

(Members of PPMC)
+1 (non binding):

(Everyone else)
...if vote was successful..
I will promote the artifacts to the central repo.
 
...if vote was unsuccessful..
(List of series of tasks that have been created or already exist that block the release)
The following Jira tasks have been created to capture the issues blocking a successful release:
 
RYA-XXX <Issue Title> [1]
RYA-XXX <Issue Title> [2]
RYA-XXX <Issue Title> [3]


(Create an issue that links to all of these issues)
The following Jira task has been created to capture all of the issues that will be resolved in the next RC:

RYA-XXX Perform 3.2.10-RC<N+1> Release [4]
 
These tasks should address the concerns raised during the voting process.



If there is something wrong with the staging repo:
delete the tag:

 

git tag -d v3.2.10-RC1
git push origin :refs/tags/v3.2.10-RC1
 
git branch -D 3.2.10-RC1
git push origin --delete 3.2.10-RC1
 

Rya uses Mini Accumulo Cluster for a number of it's tests and I've run into a number of gotchas:
  1. On windows, I've found that I need to update my hosts file to add my ip and my machine name (something like 10.aaa.bbb.ccc mymachinename)
  2. Close all VPNs
  3. Do not use strange DNS machines.  just use the default ones your network/isp provides
  4. McAfee Virus Scan may slow things down and throw off the test



When merging a pull request, it's important to verify whether or not new commits are pulling in any third party

dependencies that are incompatible with ASF.  To check whether the pull request contains invalid dependencies issue

the following command in your terminal:

>> mvn license:aggregate-add-third-party

 

This will generate a file THIRD-PARTY.txt in the directory target/generated-sources/license/ that lists the license for each java file in the jar.  You can now grep the directory for all licenses which are

not ASF approved licenses. 

egrep -iv "BSD|ASF|MIT|CDDL|EPL|Apache|Eclipse|Public Domain" target/generated-sources/license/THIRD-PARTY.txt

 

The above grep command does a case insensitive search over all instances of THIRD-PARTY.txt in the project for licenses that are not in the list approved Apache Licenses .

 


Other note on license from david lotts:

How to do this:
http://stackoverflow.com/questions/3500388/finding-out-the-licenses-of-jar-libraries
The Maven "Project Info Reports" plugin produces a Dependencies report that includes the Licenses for the dependencies.







References:

http://www.apache.org/dev/publishing-maven-artifacts.html

 

 

 




  • No labels