Author: wsmoak Date: Sun Feb 17 22:23:37 2008 New Revision: 628625 URL: http://svn.apache.org/viewvc?rev=628625&view=rev Log: Update the release process to reflect staging and voting on the actual artifacts.
Modified: maven/site/trunk/src/site/apt/developers/release/pmc-release-process.apt Modified: maven/site/trunk/src/site/apt/developers/release/pmc-release-process.apt URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/release/pmc-release-process.apt?rev=628625&r1=628624&r2=628625&view=diff ============================================================================== --- maven/site/trunk/src/site/apt/developers/release/pmc-release-process.apt (original) +++ maven/site/trunk/src/site/apt/developers/release/pmc-release-process.apt Sun Feb 17 22:23:37 2008 @@ -28,7 +28,7 @@ Introduction - This document gives step-by-step instructions for releasing a part of Maven. The primary audience is Maven PMC. + This document gives step-by-step instructions for releasing a part of Maven. The primary audience is Maven committers. Prerequisite @@ -39,7 +39,7 @@ * you have created your GPG keys. For more information, please refer to {{{pmc-gpg-keys.html}Making GPG Keys}}. -Release Process for Part Of Maven +Release Process for a Maven Plugin [[1]] Prepare your poms for release: @@ -63,23 +63,49 @@ * Remember to do '<<<mvn release:clean>>>' before you start the real release process. - [[2]] Publish a snapshot: + [] + + [] + + [] + + [[4]] Prepare the release +-----+ ->mvn deploy -... -[INFO] [deploy:deploy] -[INFO] Retrieving previous build number from apache.snapshots +>mvn release:prepare \ + -Dtag=maven-XXX-plugin-2.1 \ + -B \ + -DtagBase=https://svn.apache.org/repos/asf/maven/plugins/tags \ + -Dusername=YOUR_APACHE_USERNAME + ... ++-----+ + + <<Note>>: a release.properties file should be generated with release configuration. DO NOT DELETE IT before release. + + [[5]] Stage the release. + + It should deploy several JARS (maven-XXX-plugin-2.1.jar, maven-XXX-plugin-2.1-javadoc.jar + and maven-XXX-plugin-2.1-sources.jar), maven-XXX-plugin-2.1.pom and their associated md5 and sha1 files. + ++-----+ +>mvn release:perform -DstagingUrl=... ... +-----+ - <<Note>>: You could verify the deployment under Maven Snapshot repository on Apache. + <<Note>>: Maven could stop after <<<[INFO] [deploy:deploy]>>>. You need to review your authentification settings + for Apache (SSH public/private keys) or your servers in the settings.xml. You could try also the following + (NOT recommended) : +-----+ -http://people.apache.org/repo/m2-snapshot-repository/org/apache/maven/plugins/maven-XXX-plugin/2.1/ +>cd target/checkout +>mvn deploy site-deploy --no-plugin-updates -DperformRelease=true +-----+ + + All artifacts must be accompanied by detached signature (.asc) files. + The Maven GPG Plugin is configured to do this automatically. - [[3]] Propose a vote on the dev list with the closed issues, the issues left and the staging site. For instance: + [[3]] Propose a vote on the dev list with the closed issues, the issues left and the staging repo and site urls. + For instance: +-----+ To: "Maven Developers List" <[EMAIL PROTECTED]> @@ -97,7 +123,7 @@ http://people.apache.org/~YOUR_APACHE_USERNAME/maven-XXX-plugin/ Vote open for 72 hours, based on: -maven-XXX-plugin-2.1-20061005.000031-3.jar (rev 453071) +http://people.apache.org/~YOUR_APACHE_USERNAME/staging-repo [ ] +1 [ ] +0 @@ -107,92 +133,21 @@ Once a vote is successful, post the result to the dev list. - [[4]] Prepare the release + [[5]] Sync the release to central + + See the Maven Stage Plugin docs for more information. -+-----+ ->mvn release:prepare \ - -Dtag=maven-XXX-plugin-2.1 \ - -B \ - -DtagBase=https://svn.apache.org/repos/asf/maven/plugins/tags \ - -Dusername=YOUR_APACHE_USERNAME -... -+-----+ - - <<Note>>: a release.properties file should be generated with release configuration. DO NOT DELETE IT before release. - - [[5]] Perform the release. - - It should deploy several JARS (maven-XXX-plugin-2.1.jar, maven-XXX-plugin-2.1-javadoc.jar - and maven-XXX-plugin-2.1-sources.jar), maven-XXX-plugin-2.1.pom and their associated md5 and sha1 files. - -+-----+ ->mvn release:perform -... -+-----+ - - <<Note>>: Maven could stop after <<<[INFO] [deploy:deploy]>>>. You need to review your authentification settings - for Apache (SSH public/private keys) or your servers in the settings.xml. You could try also the following - (NOT recommended) : - -+-----+ ->cd target/checkout ->mvn deploy site-deploy --no-plugin-updates -DperformRelease=true -+-----+ - - <<Note>>: You could verify the deployment under Maven Rsync repository on Apache. + <<Note>>: You could verify the deployment under Maven Rsync repository on Apache. +-----+ http://people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/maven/plugins/maven-XXX-plugin/2.1/ +-----+ - [[6]] Sign Releases + [[8]] Publish the plugin website and versioned docs from the tag - Signatures for all varieties of release need to be created. The signature files should be named after the original - with the .asc suffix. + mvn site-deploy -+-----+ ->cd target/checkout/target ->gpg --armor --output maven-XXX-plugin-2.1-javadoc.jar.asc --detach-sig \ - maven-XXX-plugin-2.1-javadoc.jar -You need a passphrase to unlock the secret key for user: "Vincent Siveton <[EMAIL PROTECTED]>" -1024-bit DSA key, ID XXXXXXXX, created 2006-10-09 ->gpg --armor --output maven-XXX-plugin-2.1.jar.asc --detach-sig \ - maven-XXX-plugin-2.1.jar -... ->gpg --armor --output maven-XXX-plugin-2.1-sources.jar.asc --detach-sig \ - maven-XXX-plugin-2.1-sources.jar -... -+-----+ - - <<Note>>: You could also sign all required files with the following scripts: - -+-----+ -# Unix OS ->cd target/checkout/target ->for i in *.jar; do gpg --output $i.asc --detach-sig --armor $i; done -+-----+ -+-----+ -# Windows OS ->cd target/checkout/target ->for %i in (*.jar) do gpg --output %i.asc --detach-sig --armor %i -+-----+ - - <<Note>>: You could verify the signatures with the following - -+-----+ ->gpg --verify maven-javadoc-plugin-2.1.jar.asc maven-javadoc-plugin-2.1.jar -gpg: Signature made 10/09/06 11:22:35 using DSA key ID XXXXXXXX -gpg: Good signature from "Vincent Siveton <[EMAIL PROTECTED]>" -+-----+ - - [[7]] Upload Sign Releases - - Upload the detached signature files (.asc) for these releases to m2-ibiblio-rsync-repository directory on - Apache, i.e.: - -+-----+ -/www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/apache/maven/plugins/maven-XXX-plugin/2.1/ -+-----+ + mvn site:stage-deploy [[8]] Review Website @@ -200,8 +155,11 @@ +-----+ http://maven.apache.org/plugins/maven-XXX-plugin + +http://maven.apache.org/plugins/maven-XXX-plugin-2.1 +-----+ + [[9]] Update the plugins page If this is a plugin release, update the version number for the plugin on the