Here are a bunch of good guides:
http://accumulo.apache.org/releasing.html
http://accumulo.apache.org/verifying_releases.html
http://yetus.apache.org/contribute/releases/
How to Improve this Page
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 First-Time Preparation
Before a Release Manager begins cutting a release of Apache Rya, there are a handful of Dependencies and one-time Prerequisites they need to satisfy:
- 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. - Checkout and Build Rya
The Release Manager should verify that they can checkout, build, and test Apache Rya on their machine.Checkout code from Git
git clone https://git-wip-us.apache.org/repos/asf/incubator-rya.git incubator-rya cd incubator-rya
Build and Test Apache Rya
mvn clean install
- 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.- Getting software
- Get GPG. (PGP should work as well, but this guide uses GPG). It is probably already available in your linux distro.
Get 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.
- Here is a working example of ~/.gnupg/gpg-agent.conf
default-cache-ttl 28800
# 8 hours
pinentry-program /usr/bin/pinentry-curses
allow-loopback-pinentry
make sure you reset gpg-agent:
echo RELOADAGENT | gpg-connect-agent
Using Fedora, might need to use gpg2. These two must match:
gpg --version
- gpg-agent --version
If they don't, check for version 2:
- gpg2 --version
- I was able to copy/link the commands in /usr/bin/: mv gpg gpg1 and ln -s gpg2 gpg
- Creating a key If you do not have a GPG key, reference the very thorough ASF release signing documentation available at https://www.apache.org/dev/release-signing.html.
- Publishing a key to a public server
- Adding your key to id.apache.org
- Getting software
- Setting up Maven to push to apache repo
- Username/pass in maven settings
- Add Key to KEYS file
See it here:
https://dist.apache.org/repos/dist/release/incubator/rya/KEYS
Do this with your name where it says "David":
svn checkout https://dist.apache.org/repos/dist/release/incubator/rya
(gpg --list-sigs "David" && gpg --armor --export "David") >> rya/KEYS
cd rya
svn commit -m "Adding David to KEYS"
- Testing settings
- Testing locally:
- mvn clean install -Papache-release
Testing by pushing to apache snapshot repo
mvn clean deploy -Papache-release
- Testing private key use and gpg-agent prompting. This is a way to preload the key before the release build below. Do this with your name (Unique initial characters of the full name are accepted) where it says "David":
eval $(gpg-agent --daemon) ### Start the gpg-agent if not already.
echo "hello" >> text.txt
gpg -e -u "Aaron" -r "David" text.txt ### These names are actually in the Rya keys file.
gpg -d text.txt.gpg ### this will prompt for David's key decrypt password and cache it.
- Testing locally:
Staging a Release
- Communicate: Give notice of the intent and timing of the release to the developer's list: dev@rya.incubator.apache.org
Later, request descriptions for the release notes. A day before cutting a release candidate, do a last call for Pull requests. - Checkout out code
git clone https://git-wip-us.apache.org/repos/asf/incubator-rya.git incubator-rya
cd incubator-rya
- Create release candidate branch from master. Name the branch <releaseVersion>-RC<N>
git checkout -b 3.2.10-RC2 master
mvn clean release:prepare -Pgeoindexing -Pbenchmark -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: :
For the next step, create file: settings.xml containing your Apache Nexus username and password. Make sure you remove the password after your done. You can checking your password by logging in at: https://repository.apache.org/
<?xml version="1.0" encoding="UTF-8"?> <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <servers> <server> <id>apache.releases.https</id> <username>PUT_USERID_HERE</username> <password>PUTPASSWORDHERE</password> </server> </servers> <pluginGroups></pluginGroups> <proxies></proxies> <mirrors></mirrors> <profiles></profiles> </settings>
Then perform the release for the release candidate. If this command fails with "Return code is: 401, ReasonPhrase: Unauthorized." then your user/password is wrong, or you already have a file with the same name. See this for troubleshooting: https://stackoverflow.com/questions/24830610/why-am-i-getting-a-401-unauthorized-error-in-maven
mvn release:perform -Darguments="-DskipTests"
4. Add the artifacts to dist
cd .. svn checkout https://dist.apache.org/repos/dist/dev/incubator/rya cd rya mkdir rya-incubating-3.2.10-rc3 cd rya-incubating-3.2.10-rc3 cp ../../incubator-rya/target/checkout/target/rya-project-3.2.10-incubating-source-release.zip* . openssl md5 -r rya-project-3.2.10-incubating-source-release.zip > rya-project-3.2.10-incubating-source-release.zip.md5 openssl sha1 -r rya-project-3.2.10-incubating-source-release.zip > rya-project-3.2.10-incubating-source-release.zip.sha1 openssl sha512 -r rya-project-3.2.10-incubating-source-release.zip > rya-project-3.2.10-incubating-source-release.zip.sha512 cd .. svn add rya-incubating-3.2.10-rc3 svn commit -m "Adding rya-incubating-3.2.10-rc3"
5. Check that your keys are in the file: KEYS . It is here: https://dist.apache.org/repos/dist/release/incubator/rya/KEYS
If not, see Release Manager Dependencies section above.
- 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
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
find . -type f | grep -v '\/target\/\|\/test\/\|\/site\/\|\.java\|\.xml\|\.xsl\|\.groovy\|\.properties\|\.sh\|\.bat\|\.md\|\.txt'
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)
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. Then please vote: [ ] +1 Release this package as rya-project-3.2.10 [ ] +0 no opinion [ ] -1 Do not release this package because because...
If the vote was unsuccessful, respond to the dev list with the "Unsuccessful" Vote Email
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 failed. +1 (binding): (Members of PPMC) +1 (non binding): (Everyone else) (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.
Since Rya is still incubating, Rya must pass a vote on the general@incubator.apache.org list as well.
First, create a Result/Vote email on dev:
To: dev@rya.incubator.apache.org Subject: [RESULT] [VOTE] Release Apache Rya (Incubating) version 3.2.10 RC3 This vote passes with +<N> Binding and +<N> Non-binding votes. +1 (binding): (Members of PPMC) +1 (non binding): (Everyone else) I'll be sending a vote email to the IPMC soon
The create an email on the IPMC Email:
To: dev@rya.incubator.apache.org, general@incubator.apache.org Subject: [VOTE] Release Apache Rya (Incubating) version 3.2.10 RC3 The Apache Rya community has voted and approved the proposed release of Apache Rya 3.2.10 (Incubating) RC3. We now kindly request the Incubator PMC members review and vote on this incubator release. Rya (pronounced "ree-uh" /rēə/) is a cloud-based RDF triple store that supports SPARQL queries. Rya is a scalable RDF data management system built on top of Apache Accumulo®. Rya uses novel storage methods, indexing schemes, and query processing techniques that scale to billions of triples across multiple nodes. Rya provides fast and easy access to the data through SPARQL, a conventional query mechanism for RDF data. More information can be found at http://rya.incubator.apache.org/ [VOTE] Thread: https://lists.apache.org/thread.html/01d692717b2ee088253fa96c42759309a2a4d2aaf9867905bc473fa7@%3Cdev.rya.apache.org%3E [VOTE RESULT] Thread: https://lists.apache.org/thread.html/e58e7456987d74f11a0698fd5d4dde436bd83016baa269c149f03511@%3Cdev.rya.apache.org%3E <cut and paste from vote email on dev list.
Final Release Email
To: dev@rya.incubator.apache.org, general@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. +1 (binding): (Members of PPMC) (Members of IPMC) +1 (non binding): (Everyone else) I will promote the artifacts to the central repository.
To: announce@apache.org, dev@rya.incubator.apache.org, general@incubator.apache.org Subject: [ANNOUNCE] Apache Rya 3.2.10-incubating released The Apache Rya (Incubating) team is happy to announce the release of Apache Rya 3.2.10-incubating: https://rya.incubator.apache.org/release/rya-3.2.10-incubating/ Rya (pronounced "ree-uh" /rēə/) is a cloud-based RDF triple store that supports SPARQL queries. Rya is a scalable RDF data management system built on top of Apache Accumulo®. Rya uses novel storage methods, indexing schemes, and query processing techniques that scale to billions of triples across multiple nodes. Rya provides fast and easy access to the data through SPARQL, a conventional query mechanism for RDF data. Thanks, The Apache Rya team ===== *Disclaimer* Apache Rya (incubating) is an effort undergoing Incubation at The Apache Software Foundation (ASF), sponsored by the Incubator. 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.
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
- 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)
- Close all VPNs
- Do not use strange DNS machines. just use the default ones your network/isp provides
- 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.
The following 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 .
egrep -iv "BSD|ASF|MIT|CDDL|EPL|Apache|Eclipse|Public Domain" target/generated-sources/license/THIRD-PARTY.txt
How to discover all the licenses for all the included libraries: 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.
After the release has been approved by IPMC
- Release the Jars
- Go to https://repository.apache.org/ and release the staging repository
Copy dist/dev artifacts to dist/release
### Starting from the folder where you svn checkout for the RC3: mv rya ryadev # first rename the RC3 dist/dev repo svn checkout https://dist.apache.org/repos/dist/release/incubator/rya mv rya ryarelease cd ryarelease mv ../ryadev/rya-incubating-3.2.10-rc3 ./ mv rya-incubating-3.2.10-rc3 rya-incubating-3.2.10 svn add rya-incubating-3.2.10 svn commit -m "Adding rya-incubating-3.2.10"
- Create a rel/ tag in Git
git checkout rya-incubating-3.2.10-rc3
git tag -a rel/rya-incubating-3.2.10 -m "rya-incubating-3.2.10 Release"
git push origin rel/rya-incubating-3.2.10
- Merge Release branch into Master and Delete Release Branch
git checkout master
- git pull origin
git merge 3.2.10-RC3
- git push origin master
- If everything looks great, delete the branches:
git push origin --delete 3.2.11-RC3
git push origin --delete 3.2.11-RC2
git push origin --delete 3.2.11-RC1 - And tags:
git push --delete origin rya-incubating-3.2.10-rc2
git push --delete origin rya-incubating-3.2.10-rc1
git tag --delete rya-incubating-3.2.10-rc1 ### local repo
git tag --delete rya-incubating-3.2.10-rc2 ### local repo - Update the website, see instructions on this wiki
- Send out an announce email
References:
http://www.apache.org/dev/publishing-maven-artifacts.html