Author: juanpablo
Date: Fri Dec 20 22:50:03 2013
New Revision: 1552834
URL: http://svn.apache.org/r1552834
Log:
added tl;dr section
Modified:
jspwiki/site/trunk/content/ppmc/how_to_release.mdtext
Modified: jspwiki/site/trunk/content/ppmc/how_to_release.mdtext
URL:
http://svn.apache.org/viewvc/jspwiki/site/trunk/content/ppmc/how_to_release.mdtext?rev=1552834&r1=1552833&r2=1552834&view=diff
==============================================================================
--- jspwiki/site/trunk/content/ppmc/how_to_release.mdtext (original)
+++ jspwiki/site/trunk/content/ppmc/how_to_release.mdtext Fri Dec 20 22:50:03
2013
@@ -6,6 +6,40 @@ Title: How to Release
[TOC]
+## tl;dr
+
+Once you've done your first release, you'd most probably be more comfortable
with
+the quick guide to get the release out (nevertheless, all steps are explained
below):
+
+ 1. Prepare the release
+
+ mvn clean install apache-rat:rat -Papache-release #
generates artifacts, checks for AL headers
+ mvn release:prepare -DdryRun=true -DautoVersionSubmodules=true #
review pom.xml, confirm only appropiate sections have been changed
+ mvn deploy #
deploy a snapshot
+ mvn release:clean #
prepare the release 1/3
+ mvn release:prepare -DautoVersionSubmodules=true #
prepare the release 2/3
+ mvn release:perform #
prepare the release 3/3
+
+ 2. Close the staging repo
+
+ 3. Copy binaries and source to `people.apache.org`
+
+ cd target/checkout
+ scp target/jspwiki-builder-X.Y.Z-source-release.zip*
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/source
+ scp jspwiki-war/target/JSPWiki-*
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/binaries
+ scp jspwiki-war/target/JSPWiki.war*
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/binaries
+ find . -name jspwiki-wikipages-*zip* -exec scp {}
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/wikipages \;
+
+ 4. Run the vote and, if successful, continue with the items on the list
+
+ 5. Publish Nexus repository
+
+ 6. Publish binaries and source to the [mirrors][]
+
+ 7. Wait for 24 hours, then announce the release
+
+ 8. Add the next release version to JIRA
+
## First time release managers
1. Generate [PGP code signing keys][]
@@ -50,7 +84,7 @@ on `people.apache.org`, otherwise you'll
1. **Generate artifacts**
- mvn clean apache-rat:rat install -Papache-release
+ mvn clean install apache-rat:rat -Papache-release
This will check that all files have AL headers and also build artifacts,
sources and sign
@@ -87,11 +121,13 @@ current repository and delete any `asc.m
using "Apache JSPWiki X.Y.Z" as the description to allow others
to see the repository.
- 5. **Copy the bin distribution files and checksums to people.apache.org**,
-excluding the `asc.md5/asc.sha1` files:
+ 5. **Copy the bin distribution files and checksums to people.apache.org*:
- find . -name target/*asc.* -exec rm {} \;
- scp target/*
[email protected]:~/public_html/jspwiki-X.Y.Z-candidate-$RC
+ cd target/checkout
+ scp target/jspwiki-builder-X.Y.Z-source-release.zip*
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/source
+ scp jspwiki-war/target/JSPWiki-*
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/binaries
+ scp jspwiki-war/target/JSPWiki.war*
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/binaries
+ find . -name jspwiki-wikipages-*zip* -exec scp {}
[email protected]:~/public_html/jspwiki-X.Y.Z-rc$RC/wikipages \;
## Run a vote
@@ -99,14 +135,14 @@ excluding the `asc.md5/asc.sha1` files:
Subject: [VOTE] Release JSPWiki version X.Y.Z
- This is a release for Apache JSPWiki, version X.Y.Z.
+ This is a release vote for Apache JSPWiki, version X.Y.Z. The vote
will be open for at least 72 hours from now.
It fixes the following issues:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310732&version=<REPLACE>
- *** Please download, test and vote by [3 working days after sending].
-
Note that we are voting upon the source (tag), binaries are provided
for convenience.
+
+ Everybody is encouraged to vote.
Source and binary files:
http://people.apache.org/~<REPLACE>/jspwiki-X.Y.Z-candidate-$RC
@@ -116,6 +152,12 @@ excluding the `asc.md5/asc.sha1` files:
JSPWiki's KEYS file containing PGP keys we use to sign the release:
http://www.apache.org/dist/jspwiki/KEYS
+
+ *** Please download, test and vote:
+
+ [ ] +1 Approve the release
+ [ ] 0 Don't mind
+ [ ] -1 Disapprove the release (please provide specific comments)
Note that the PMC needs to vote upon the release before any release can be
made official.
@@ -177,7 +219,7 @@ changes on the front page of the site
The Apache JSPWiki Team
-## Add the next release to JIRA
+## Add the next release version to JIRA
1. Add the [next version number to JIRA][]
@@ -213,9 +255,7 @@ changes on the front page of the site
* [Maven release plugin cheat sheet][loi_1]
* [Publishing Maven Artifacts - setup your development environment][loi_2]
* [Maven release plugin][loi_3]
-* Repository management with Nexus: [Chapter 11. Improved Releases with the
Nexus Staging Suite
-][loi_4]
-
+* Repository management with Nexus: [Chapter 11. Improved Releases with the
Nexus Staging Suite][loi_4]
[Maven encryption capabilities]:
http://maven.apache.org/guides/mini/guide-encryption.html
