You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rave.apache.org by mf...@apache.org on 2011/06/15 23:35:15 UTC
svn commit: r1136203 - in /incubator/rave/site/trunk/content/rave:
release-process.mdtext release-setup.mdtext
Author: mfranklin
Date: Wed Jun 15 21:35:14 2011
New Revision: 1136203
URL: http://svn.apache.org/viewvc?rev=1136203&view=rev
Log:
Updated release documentation (Supports RAVE-46)
Modified:
incubator/rave/site/trunk/content/rave/release-process.mdtext
incubator/rave/site/trunk/content/rave/release-setup.mdtext
Modified: incubator/rave/site/trunk/content/rave/release-process.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/release-process.mdtext?rev=1136203&r1=1136202&r2=1136203&view=diff
==============================================================================
--- incubator/rave/site/trunk/content/rave/release-process.mdtext (original)
+++ incubator/rave/site/trunk/content/rave/release-process.mdtext Wed Jun 15 21:35:14 2011
@@ -1,4 +1,4 @@
-Title:Release Process
+Title: Release Process
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
@@ -21,23 +21,23 @@ Notice: Licensed to the Apache Softwa
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"`
+ 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. Also, transition any Resolved issues to the Closed state.
- 2. Update the text files in a working copy of the project root -
- 1. Update the CHANGES.txt 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.
+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. Also, transition any Resolved issues to the Closed state.
+ 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/branch to release using command line svn.
+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.*
+ *Do not use Eclipse to do the checkout. The extra dot (.) files created by Eclipse throws off the rat:check processing.*
4. Use `mvn verify` to verify the source has the required headers before trying to release.
5. Do a dry run of the release:prepare step.
@@ -47,29 +47,29 @@ Notice: Licensed to the Apache Softwa
* New development version - take the default
* GPG Passprhase
- `$ mvn -Papache-release release:prepare -DdryRun=true`
+ $ mvn -Papache-release release:prepare -DdryRun=true
- *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.*
+ *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.*
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. If other formatting changes have been made you should review the changes and then commit them -
- `$ svn commit -m "fixing formatting for release"`
+ $ svn commit -m "fixing formatting for release"
3. 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.
- 4. verify signatures ([Verifying release signatures](http://incubator.apache.org/bval/cwiki/release-process.html#ReleaseProcess-Verifyingreleasesignatures))
+ 4. verify signatures ([Verifying release signatures](http://incubator.apache.org/rave/cwiki/release-process.html#ReleaseProcess-Verifyingreleasesignatures))
7. Once any failures or required updates have been committed to svn, rollback the release prepare files -
- `$ mvn -Papache-release release:rollback`
+ $ mvn -Papache-release release:rollback
8. Prepare the release
1. Run the "release:prepare" step for real this time. You'll be prompted for the same version information.
*Different arguments and steps are required as there are problems with the maven-jar-plugin and maven-release-plugin when using the test-jar goal. See http://jira.codehaus.org/browse/MJAR-68 and http://jira.codehaus.org/browse/MRELEASE-285.*
- `$ mvn release:prepare -Papache-release -DskipTests=true -DpreparationGoals="clean install cargo:package"`
+ $ mvn release:prepare -Papache-release -DpreparationGoals="clean install cargo:package"
2. Backup (zip or tar) your local release candidate directory in case you need to rollback the release after the next step is performed.
@@ -77,26 +77,25 @@ Notice: Licensed to the Apache Softwa
This step will create a maven staging repository and site for use in testing and voting.
- `$ mvn release:perform -Papache-release -Duser.name=<your_apache_uid>`
-
- *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.*
-
- *The maven-release-plugin is configured with goals "deploy site site:deploy" and will deploy the site files to a staging-site directory on people.apache.org.*
+ $ mvn release:perform -Papache-release -Duser.name=<your_apache_uid>
+
+ *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.*
+ *The maven-release-plugin is configured with goals "deploy site site:deploy" and will deploy the site files to a staging-site directory on people.apache.org.*
10. Verify the release artifacts
1. Verify the HTML links in site are correct
2. Verify the staged artifacts in the nexus repo
1. https://repository.apache.org/index.html
2. Enterprise --> Staging
- 3. Staging tab --> Name column --> org.apache.bval
+ 3. Staging tab --> Name column --> org.apache.rave
4. 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
3. Close the nexus staging repo
1. https://repository.apache.org/index.html
2. Enterprise --> Staging
- 3. Staging tab --> Name column --> org.apache.bval
- 4. Right click on the open staging repo (org.apache.bval-XXX) and select Close.
+ 3. Staging tab --> Name column --> org.apache.rave
+ 4. Right click on the open staging repo (org.apache.rave-XXX) and select Close.
11. Put the release candidate up for a vote
- 1. Create a VOTE email thread on bval-dev@ to record votes as replies, like [this](release-vote.txt)
- 2. Create a DISCUSS email thread on bval-dev@ for any vote questions, [this](release-discuss.txt)
+ 1. Create a VOTE email thread on rave-dev@ to record votes as replies, like [this](release-vote.txt)
+ 2. Create a DISCUSS email thread on rave-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)
@@ -124,18 +123,18 @@ Notice: Licensed to the Apache Softwa
1. Promote the staged nexus artifacts -
1. https://repository.apache.org/index.html
2. Enterprise --> Staging
- 3. Staging tab --> Name column --> org.apache.bval
- 4. Right click on the closed staging repo (org.apache.bval-XXX) and select Promote.
+ 3. Staging tab --> Name column --> org.apache.rave
+ 4. Right click on the closed staging repo (org.apache.rave-XXX) and select Promote.
2. Copy the distribution artifacts over to the distribution area
$ ssh ${user.name}@people.apache.org
- $ mkdir /www/www.apache.org/dist/incubator/bval/${project.version}
- $ cd /www/www.apache.org/dist/incubator/bval/${project.version}
- $ wget https://repository.apache.org/content/repositories/releases/org/apache/bval/bval-parent/${project.version}/bval-parent-${project.version}-source-release.zip
- $ wget https://repository.apache.org/content/repositories/releases/org/apache/bval/bval-parent/${project.version}/bval-parent-${project.version}-source-release.zip.asc
- $ wget https://repository.apache.org/content/repositories/releases/org/apache/bval/bval-parent/${project.version}/bval-parent-${project.version}-source-release.zip.md5
- $ wget https://repository.apache.org/content/repositories/releases/org/apache/bval/bval-parent/${project.version}/bval-parent-${project.version}-source-release.zip.sha1
+ $ mkdir /www/www.apache.org/dist/incubator/rave/${project.version}
+ $ cd /www/www.apache.org/dist/incubator/rave/${project.version}
+ $ wget https://repository.apache.org/content/repositories/releases/org/apache/rave/rave-parent/${project.version}/rave-parent-${project.version}-source-release.zip
+ $ wget https://repository.apache.org/content/repositories/releases/org/apache/rave/rave-parent/${project.version}/rave-parent-${project.version}-source-release.zip.asc
+ $ wget https://repository.apache.org/content/repositories/releases/org/apache/rave/rave-parent/${project.version}/rave-parent-${project.version}-source-release.zip.md5
+ $ wget https://repository.apache.org/content/repositories/releases/org/apache/rave/rave-parent/${project.version}/rave-parent-${project.version}-source-release.zip.sha1
**Make sure all the copied files have g+rw set and only o+r set**
@@ -149,8 +148,8 @@ Notice: Licensed to the Apache Softwa
14. Update the JIRA versions page to 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
1. After the mirrors have had time to update (24 hours to be on the safe side) update the wiki with pointers to the new release
- 2. Make a news announcement on the BeanValidation wiki.
- 3. Make an announcement about the release on the bval-users@incubator.apache.org, bval-dev@incubator.apache.org, general@incubator.apache.org, and announce@apache.org list as per the Apache Announcement Mailing Lists page)
+ 2. Make a news announcement on the Rave homepage.
+ 3. Make an announcement about the release on the rave-users@incubator.apache.org, rave-dev@incubator.apache.org, general@incubator.apache.org, and announce@apache.org list as per the Apache Announcement Mailing Lists page)
####Recovering from a vetoed release
@@ -168,13 +167,13 @@ Notice: Licensed to the Apache Softwa
3. Delete the svn tag created by the release:perform step -
- $ svn del https://svn.apache.org/repos/asf/incubator/bval/tags/0.1-incubating -m "deleting tag from rolled back release"
+ $ svn del https://svn.apache.org/repos/asf/incubator/rave/tags/0.1-incubating -m "deleting tag from rolled back release"
4. Drop the nexus staging repo
1. https://repository.apache.org/index.html
2. Enterprise --> Staging
- 3. Staging tab --> Name column --> org.apache.bval
- 4. Right click on the closed staging repo (org.apache.bval-XXX) and select Drop.
+ 3. Staging tab --> Name column --> org.apache.rave
+ 4. Right click on the closed staging repo (org.apache.rave-XXX) and select Drop.
5. Remote the staged site
Modified: incubator/rave/site/trunk/content/rave/release-setup.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/release-setup.mdtext?rev=1136203&r1=1136202&r2=1136203&view=diff
==============================================================================
--- incubator/rave/site/trunk/content/rave/release-setup.mdtext (original)
+++ incubator/rave/site/trunk/content/rave/release-setup.mdtext Wed Jun 15 21:35:14 2011
@@ -1,5 +1,5 @@
-Title:Release Guide
-Notice: Licensed to the Apache Software Foundation (ASF) under one
+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
@@ -15,6 +15,7 @@ Notice: Licensed to the Apache Softwa
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.*
@@ -25,7 +26,7 @@ These setup steps only need to be perfor
*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`
+ $ 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).
@@ -33,29 +34,26 @@ These setup steps only need to be perfor
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.
- `
+ $ 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
- `
+ $ 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
- `
+ $ 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
- `
+ $ 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"
@@ -64,7 +62,7 @@ These setup steps only need to be perfor
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`
+ $ 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.*
@@ -73,7 +71,7 @@ These setup steps only need to be perfor
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`
+ $ 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.
@@ -83,7 +81,7 @@ These setup steps only need to be perfor
3. Backup your home directory to another media ||
4. Add your public key to the [SVN repository](https://svn.apache.org/repos/asf/incubator/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>`
+ $ gpg --list-sigs <Real Name> && gpg --armor -- export <Real Name>
*The [KEYS](https://svn.apache.org/repos/asf/incubator/rave/KEYS) file is updated via normal svn commit procedures. The one under w.a.o/dist/ has to be manually updated from svn.*