You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streams.apache.org by le...@apache.org on 2012/12/20 02:16:07 UTC
svn commit: r1424255 - in /incubator/streams/site/trunk:
content/release-management.mdtext content/release-setup.mdtext
content/resources.mdtext lib/path.pm
Author: letourneau
Date: Thu Dec 20 01:16:07 2012
New Revision: 1424255
URL: http://svn.apache.org/viewvc?rev=1424255&view=rev
Log:
added release management information - used Rave as source
Added:
incubator/streams/site/trunk/content/release-management.mdtext
incubator/streams/site/trunk/content/release-setup.mdtext
Modified:
incubator/streams/site/trunk/content/resources.mdtext
incubator/streams/site/trunk/lib/path.pm
Added: incubator/streams/site/trunk/content/release-management.mdtext
URL: http://svn.apache.org/viewvc/incubator/streams/site/trunk/content/release-management.mdtext?rev=1424255&view=auto
==============================================================================
--- incubator/streams/site/trunk/content/release-management.mdtext (added)
+++ incubator/streams/site/trunk/content/release-management.mdtext Thu Dec 20 01:16:07 2012
@@ -0,0 +1,218 @@
+Title: Release Management
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+###Release Steps Overview
+There are two distinct sets of artifacts that are released on independent schedules: streams-master & streams-project. The streams-master is the project metadata and only needs to be released when there is a change in the structure of the project itself. The streams-project artifacts are comprised of all streams source code, binaries and a standalone demo. For release setup information, refer to [Release Setup Information](/release-setup.html).
+
+All of the steps below apply to both the master and project releases, unless otherwise specified. As an alternative to releasing separately, the projects MAY be released together as one combined release. The steps for this can be found below. ([Combined Release Steps](#combined))
+
+####Common Release Steps
+
+1. Environment setup for releasing artifacts (same for SNAPSHOTs and releases)
+
+ 1. Increase the default Java heap available to Maven (required for Java SE 6)
+
+ export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m"
+
+ 2. Use the latest Sun 1.6.0 JDK
+ 3. Use Maven 3.0.3 or later
+
+ 4. Make sure the [Release Setup](release-setup.html) steps have been performed.
+
+2. Prepare the source for release:
+ 1. Cleanup JIRA so the Fix Version in issues resolved since the last release includes this release version correctly.
+ 2. Update the text files in a working copy of the project root -
+ 1. Update the CHANGELOG based on the Text release reports from JIRA.
+ 2. Review and update README.txt if needed.
+ 3. Commit any changes back to svn
+ 3. Stage any Roadmap or Release landing pages on the site.
+
+3. Checkout a clean copy of the trunk to release using command line svn.
+
+ *Do not use Eclipse to do the checkout. The extra dot (.) files created by Eclipse throws off the rat:check processing.*
+
+4. Verify the source has the required license headers before trying to release:
+
+ $ mvn -P pedantic verify -DskipTests
+
+5. Do a dry run of the release:prepare step:
+
+ $ mvn -P apache-release release:prepare -DautoVersionSubmodules=true -DdryRun=true
+
+ The dry run will not commit any changes back to SVN and gives you the opportunity to verify that the release process will complete as expected. You will be prompted for the following information :
+
+ * Release version - take the default
+ * SCM release tag - *DO NOT TAKE THE DEFAULT* - ${project.version}
+ * New development version - take the default
+ * GPG Passprhase
+
+ *If you cancel a release:prepare before it updates the pom.xml versions, then use the release:clean goal to just remove the extra files that were created.*
+
+ The Maven release plugin checks for SNAPSHOT dependencies in pom's. It will not complete the prepare goal until all SNAPSHOT dependencies are resolved.
+
+6. Verify that the release process completed as expected
+ 1. The release plugin will create pom.xml.tag files which contain the changes that would have been committed to SVN. The only differences between pom.xml.tag and it's corresponding pom.xml file should be the version number.
+ 2. Check release.properties and make sure that the scm properties have the right version. Sometimes the scm location can be the previous version not the next version.
+ 3. Verify signatures ([Verifying release signatures](#verify_signatures))
+
+7. Cleanup the release prepare files again:
+
+ $ mvn -P apache-release release:clean
+
+8. Prepare the release
+
+ 1. Run the "release:prepare" step for real this time. You'll be prompted for the same version information.
+
+ $ mvn -P apache-release release:prepare -DautoVersionSubmodules=true
+
+ 2. Backup (zip or tar) your local release candidate directory in case you need to rollback the release after the next step is performed.
+
+9. Perform the release
+ * This step will create a maven staging repository and site for use in testing and voting.
+
+ $ mvn release:perform -Papache-release
+
+ * *If your local OS userid doesn't match your Apache userid, then you'll have to also override the value provided by the OS to Maven for the site-deploy step to work. This is known to work for Linux, but not for Mac and unknown for Windows.*
+
+ -Duser.name=[your_apache_uid]
+
+10. Verify the Nexus release artifacts
+
+ 1. Verify the staged artifacts in the nexus repo
+ * https://repository.apache.org/index.html
+ * Staging repositories (under Build Promotion) --> Name column --> org.apache.streams
+ * Navigate through the artifact tree and make sure that all javadoc, sources, tests, jars, ... have .asc (GPG signature) and .md5 files. See http://people.apache.org/~henkp/repo/faq.html and http://www.apache.org/dev/release-signing.html#openpgp-ascii-detach-sig
+
+ 2. Close the nexus staging repo
+ * https://repository.apache.org/index.html
+ * Staging repositories (under Build Promotion) --> Name column --> org.apache.streams
+ * Click checkbox for the open staging repo (org.apache.streams-XXX) and press Close in the menu bar.
+
+
+11. Put the release candidate up for a vote
+ 1. Create a VOTE email thread on dev@ to record votes as replies, like [this](release-vote.txt)
+ 2. Create a DISCUSS email thread on dev@ for any vote questions, [this](release-discuss.txt)
+ 3. Perform a review of the release and cast your vote. See the following for more details on Apache releases
+
+ [http://www.apache.org/dev/release.html](http://www.apache.org/dev/release.html)
+
+ 4. A -1 vote does not necessarily mean that the vote must be redone, however it is usually a good idea to rollback the release if a -1 vote is received. See - Recovering from a vetoed release
+ 5. After the vote has been open for at least 72 hours, has at least three +1 PMC votes and no -1 votes, then post the results to the vote thread by -
+ * reply to the initial email and prepend to the original subject "[RESULT]"
+ * Include a list of everyone who voted +1, 0 or -1.
+
+12. Finalizing a release
+
+ 1. Promote the staged nexus artifacts
+
+ * https://repository.apache.org/index.html
+ * Staging repositories (under Build Promotion) --> Name column --> org.apache.streams
+ * Click checkbox of the closed staging repo (org.apache.streams-XXX) and select Release.
+
+ 2. Copy the source artifacts over to the distribution area
+
+ * $ svn co https://dist.apache.org/repos/dist/release/streams/sources ./streams-sources (KEEP this directory until after the release process has been completed)
+ * $ cd ./streams-sources
+ * $ wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip
+ * $ wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.asc
+ * $ wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.md5
+ * $ wget https://repository.apache.org/content/repositories/releases/org/apache/streams/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.sha1
+ * $ svn add ${project.name}-*
+ * $ svn commit -m "Committing Source Release for ${project.name}-${project.version}
+
+ 3. Copy the binary artifacts over to the distribution area (for streams-project only)
+
+ * $ svn co https://dist.apache.org/repos/dist/release/streams/binaries ./streams-binaries (KEEP this directory until after the release process has been completed)
+ * $ cd streams-binaries
+ * $ scp people.apache.org:/www/people.apache.org/builds/streams/${project.version}/* ./
+ * $ svn add *
+ * $ svn commit -m "Committing Binary Release for ${project.name}-${project.version}
+
+ 4. Update the staged website
+
+ * Update the downloads page to add new version using the mirrored URLs
+ * Modify the URL for the prior release to the archived URL for the release
+
+ 5. Publish the website
+
+ * WAIT 24hrs after committing releases for mirrors to replicate
+ * Publish updates to the download page
+
+ 6. Delete the prior versions
+
+ * Navigate to the release directories checked out in the prior steps
+ * Delete the prior release artifacts using the svn delete command
+ * Commit the deletion
+
+14. Update the JIRA versions page to close all issues, mark the version as "released", and set the date to the date that the release was approved. You may also need to make a new release entry for the next release.
+
+15. Announcing the release
+
+ * Make a news announcement on the streams homepage.
+ * Make an announcement about the release on the users@streams.apache.org, dev@streams.apache.org, and announce@apache.org list as per the Apache Announcement Mailing Lists page)
+
+
+####Recovering from a vetoed release
+
+1. Reply to the initial vote email and prepend to the original subject -
+
+ [CANCELED]
+
+3. Delete the svn tag created by the release:perform step -
+
+ $ svn del https://svn.apache.org/repos/asf/streams/tags/${project.version} -m "deleting tag from rolled back release"
+
+4. Delete the build artifacts on people & www
+ * $ rm -rfv /www/people.apache.org/builds/streams/${project.version}
+ * $ rm -rfv /www/www.apache.org/dist/streams/${project.version}
+
+4. Drop the nexus staging repo
+ 1. https://repository.apache.org/index.html
+ 2. Enterprise --> Staging
+ 3. Staging tab --> Name column --> org.apache.streams
+ 4. Right click on the closed staging repo (org.apache.streams-XXX) and select Drop.
+
+5. Remove the staged site
+
+6. Make the required updates that caused the vote to be canceled during the next release cycle
+
+<a name="verify_signatures" />
+####Verifying release signatures
+On unix platforms the following command can be executed -
+
+ for file in `find . -type f -iname '*.asc'`
+ do
+ gpg --verify ${file}
+ done
+
+You'll need to look at the output to ensure it contains only good signatures -
+
+gpg: Good signature from ...
+gpg: Signature made ...
+
+
+<a name="combined" />
+####Combined Release
+In order to perform a combined release of the streams-master and streams-project trunks, do the following:
+
+ * Perform Steps 1-9 of the [release](#release-steps) for streams Master & streams Project
+ * Do NOT perform step 10 until steps 1-9 have been completed for BOTH projects
+ * Build the streams-master FIRST
+ * When prompted to change the streams-project dependency on streams-master SNAPSHOT, do so to the release that you just built
+ * Execute the remaining steps using the following e-mail templates
+ * [PMC Release Vote](PPMC_Combined.txt)
\ No newline at end of file
Added: incubator/streams/site/trunk/content/release-setup.mdtext
URL: http://svn.apache.org/viewvc/incubator/streams/site/trunk/content/release-setup.mdtext?rev=1424255&view=auto
==============================================================================
--- incubator/streams/site/trunk/content/release-setup.mdtext (added)
+++ incubator/streams/site/trunk/content/release-setup.mdtext Thu Dec 20 01:16:07 2012
@@ -0,0 +1,94 @@
+Title: Release Setup
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+These setup steps only need to be performed on a particular machine once.
+
+*Developers using Linux workstations can skip over the references to Cygwin. If using Windows, install cygwin, including Utils/gnupg and Net/openssh packages.*
+
+####Create and install a SSH key
+1. Open a shell window. If using Windows, open a cygwin window.
+2. Use ssh-keygen to create an SSH key.
+
+ *Follow the latest steps and guides on the [ASF website](http://www.apache.org/dev/openpgp.html#generate-key) as you should **NOT** be using SHA1 and new keys **MUST** be at least 4096 bits.*
+
+ $ ssh-keygen -t rsa -b 4096
+
+ Program defaults should be fine. No passphrase is required for the ssh key generation. The keys will be saved in ~/.ssh/id_dsa (private) and ~/.ssh/id_dsa.pub (public).
+
+ *See [Authenticating By Public Key (OpenSSH)](http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html) for a good description on why and how to perform this task.*
+
+3. SCP your SSH public key ~/.ssh/id_dsa.pub created in last step to ~/id_dsa.pub on people.apache.org.
+
+ $ cd ~/.ssh
+ $ scp id_dsa.pub <your userid>@people.apache.org:id_dsa.pub
+ $ You will be prompted for your password.
+
+4. Use ssh to login to people.apache.org
+
+ $ cd ~
+ $ ssh <your userid>@people.apache.org
+
+ At this point, you will still be prompted for your password.
+
+5. Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700.
+
+ $ mkdir ~/.ssh
+ $ chmod 700 ~/.ssh
+
+6. Move or append ~/id_dsa.pub to ~/.ssh/authorized_keys and change its file mode to 600.
+
+ $ mv ~/id_dsa.pub ~/.ssh/authorized_keys
+ $ chmod 600 ~/.ssh/authorized_keys
+
+ * *Each public key in the authorized_keys spans only one line.
+ * For example: "ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107"
+ * '#' in the first column is a comment line.*
+
+7. Exit out of this ssh session.
+8. Start a new ssh session. No login should be required this time due to the private ssh key on your local box matching up with the public ssh key in your home directory (~/.ssh).
+
+ $ ssh <your userid>@people.apache.org
+
+ *If you are still prompted for a password, then you have not set up the ssh keys properly. Review the steps above and ensure that all of the steps were followed properly. Or, maybe the instructions are still not quite right and they still need some adjusting. In that case, please update the instructions accordingly.*
+
+####Create a GPG key
+
+1. Open a shell window. If using Windows, open a cygwin window.
+2. Generate a key-pair with gpg, using default key kind ("RSA and RSA") and keys size (4096).
+
+ $ gpg --gen-key
+
+ The program's default values should be fine. For the "Real Name" enter your full name (ie. Stan Programmer). For the "e-mail address" enter your apache address (ie. sprogrammer@apache.org). You will also be required to enter a "passphrase" for the GPG key generation. Keep track of this as you will need this for the Release processing.
+
+ * *The generated keys are stored in $HOME/.gnupg or %HOME%\Application Data\gnupg subdirectory.*
+ * *Save the content in this subdirectory to a safe media. This contains your private key used to sign all the Rave release materials.*
+
+3. Backup your home directory to another media ||
+4. Add your public key to the [SVN repository](https://svn.apache.org/repos/asf/rave/KEYS). See the commands describe at the beginning of this KEYS file to perform this task. The gpg key-pair is used to sign the published artifacts for the Rave releases.
+
+ $ gpg --list-sigs <Real Name> && gpg --armor -- export <Real Name>
+
+ *The [KEYS](https://svn.apache.org/repos/asf/rave/KEYS) file is updated via normal svn commit procedures. The one under w.a.o/dist/ has to be manually updated from svn.*
+
+5. Submit your public key to a key server. E.g. [SURFNET](http://pgp.surfnet.nl:11371/) or [MIT](http://pgp.mit.edu/)
+
+6. Following the instructions in http://people.apache.org/~henkp/trust/ and ask multiple (at least 3) current Apache committers to sign your public key.
+
+####Configure Maven
+
+1. Update your ~/.m2/settings.xml with the properties from [Publishing Maven Artifacts](http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env)
\ No newline at end of file
Modified: incubator/streams/site/trunk/content/resources.mdtext
URL: http://svn.apache.org/viewvc/incubator/streams/site/trunk/content/resources.mdtext?rev=1424255&r1=1424254&r2=1424255&view=diff
==============================================================================
--- incubator/streams/site/trunk/content/resources.mdtext (original)
+++ incubator/streams/site/trunk/content/resources.mdtext Thu Dec 20 01:16:07 2012
@@ -20,3 +20,5 @@ Notice: Licensed to the Apache Softwar
[Streams Proposal Wiki Page ](http://wiki.apache.org/incubator/StreamsProposal)
[ActivityStreams Specifications](http://activitystrea.ms/specs/)
+
+[Release Setup](/release-setup.html)
Modified: incubator/streams/site/trunk/lib/path.pm
URL: http://svn.apache.org/viewvc/incubator/streams/site/trunk/lib/path.pm?rev=1424255&r1=1424254&r2=1424255&view=diff
==============================================================================
--- incubator/streams/site/trunk/lib/path.pm (original)
+++ incubator/streams/site/trunk/lib/path.pm Thu Dec 20 01:16:07 2012
@@ -18,6 +18,8 @@ our @nav = (
href => "/people.html" },
{ title => "Issue Tracking",
href => "https://issues.apache.org/jira/browse/STREAMS" },
+ { title => "Release Management",
+ href => "/release-management.html" },
{ title => "Resources",
href => "/resources.html" },
{ title => "Foundation" },