Author: psharples
Date: Wed Apr 25 17:28:37 2012
New Revision: 1330430
URL: http://svn.apache.org/viewvc?rev=1330430&view=rev
Log:
More updates for the release management docs
Added:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-configuration.mdtext
incubator/wookie/site/trunk/content/wookie/docs/developer/release-management.mdtext
incubator/wookie/site/trunk/content/wookie/docs/developer/release-overview.mdtext
(contents, props changed)
- copied, changed from r1329679,
incubator/wookie/site/trunk/content/wookie/docs/developer/release.mdtext
incubator/wookie/site/trunk/content/wookie/docs/developer/release-testing.mdtext
(contents, props changed)
- copied, changed from r1306823,
incubator/wookie/site/trunk/content/wookie/docs/developer/releaseTesting.mdtext
Removed:
incubator/wookie/site/trunk/content/wookie/docs/developer/release.mdtext
incubator/wookie/site/trunk/content/wookie/docs/developer/releaseTesting.mdtext
Modified:
incubator/wookie/site/trunk/content/wookie/docs/developer/index.mdtext
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
incubator/wookie/site/trunk/templates/sidenav.mdtext
Modified: incubator/wookie/site/trunk/content/wookie/docs/developer/index.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/index.mdtext?rev=1330430&r1=1330429&r2=1330430&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/developer/index.mdtext
(original)
+++ incubator/wookie/site/trunk/content/wookie/docs/developer/index.mdtext Wed
Apr 25 17:28:37 2012
@@ -16,8 +16,8 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-This section of the site contains documentation specifcally for the
development team of Apache Wookie (Incubating).
+This section of the site contains documentation specifically for the
development team of Apache Wookie (Incubating).
- [Source Code](/wookie/docs/download.html)
- [Issue Tracker](https://issues.apache.org/jira/browse/WOOKIE)
- - [Release process](release.html): describes how to cut a release
+ - [Release process](release-management.html): Describes how to go about
making a release
Added:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-configuration.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/release-configuration.mdtext?rev=1330430&view=auto
==============================================================================
---
incubator/wookie/site/trunk/content/wookie/docs/developer/release-configuration.mdtext
(added)
+++
incubator/wookie/site/trunk/content/wookie/docs/developer/release-configuration.mdtext
Wed Apr 25 17:28:37 2012
@@ -0,0 +1,99 @@
+Title: Release Configuration
+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 configuration and setup
+
+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
+
+ Open a shell window. If using Windows, open a cygwin window.
+ 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.
+
+ 1. 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 @people.apache.org:id_dsa.pub
+ $ You will be prompted for your password.
+
+ 2. Use ssh to login to people.apache.org
+
+ $ cd ~
+ $ ssh @people.apache.org
+
+At this point, you will still be prompted for your password.
+
+ 1. Create a ~/.ssh folder in your home directory on people.apache.org and
change its file mode to 700.
+
+ $ mkdir ~/.ssh
+ $ chmod 700 ~/.ssh
+
+ 2. 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.*
+
+ 3. Exit out of this ssh session.
+
+ 4. 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 @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.
+
+You can alternatively use putty to create and install your ssh key. The
instructions [here](http://people.apache.org/~gmcdonald/ssh_putty.html) outline
the process.
+
+##Create a GPG key
+
+Apache recommend using GNU Privacy Guard to generate keys and sign artifacts.
+
+ 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. [email protected]). 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.
+
+ 3. The generated keys are stored in $HOME/.gnupg or %HOME%\Application
Data\gnupg subdirectory.
+
+ 4. Save the content in this subdirectory to a safe media. This contains your
private key used to sign all the Wookie release materials.
+
+ 5. Backup your home directory to another media ||
+
+ 6. Add your public key to the [SVN
repository](https://svn.apache.org/repos/asf/incubator/wookie/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 Wookie releases.
+
+ $ gpg --list-sigs && gpg --armor -- export
+
+ The [KEYS](https://svn.apache.org/repos/asf/incubator/wookie/KEYS) file is
updated via normal svn commit procedures.
+
+ 7. Submit your public key to a key server. E.g. [MIT](http://pgp.mit.edu/)
+
+ 8. Following the instructions in http://people.apache.org/~henkp/trust/ and
ask multiple (at least 3) current Apache committers to sign your public key.
Added:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-management.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/release-management.mdtext?rev=1330430&view=auto
==============================================================================
---
incubator/wookie/site/trunk/content/wookie/docs/developer/release-management.mdtext
(added)
+++
incubator/wookie/site/trunk/content/wookie/docs/developer/release-management.mdtext
Wed Apr 25 17:28:37 2012
@@ -0,0 +1,31 @@
+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 Management
+
+Release artifacts are distributed via the Apache Nexus repository for both
SNAPSHOT and versioned releases.
+In addition to Nexus, a source and standalone binary and WAR archive release
will be made available via the [Apache Incubator Distribution
Area](http://www.apache.org/dist/incubator/wookie/).
+
+To familiarize yourself with the notions and requirements for releasing
artifacts, please checkout the Apache Release FAQ.
+
+### Apache Wookie (Incubating) Release Guidelines
+
+ [Release Manager Configuration
Guide](/wookie/docs/developer/release-configuration.html)
+ [Release overview](/wookie/docs/developer/release-overview.html)
+ [Release Process](/wookie/docs/developer/release-process.html)
+ [Release Testing](/wookie/docs/developer/release-testing.html)
Copied:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-overview.mdtext
(from r1329679,
incubator/wookie/site/trunk/content/wookie/docs/developer/release.mdtext)
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/release-overview.mdtext?p2=incubator/wookie/site/trunk/content/wookie/docs/developer/release-overview.mdtext&p1=incubator/wookie/site/trunk/content/wookie/docs/developer/release.mdtext&r1=1329679&r2=1330430&rev=1330430&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/developer/release.mdtext
(original)
+++
incubator/wookie/site/trunk/content/wookie/docs/developer/release-overview.mdtext
Wed Apr 25 17:28:37 2012
@@ -1,4 +1,4 @@
-Title: Cutting a release
+Title: Release Overview
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
Propchange:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-overview.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Modified:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext?rev=1330430&r1=1330429&r2=1330430&view=diff
==============================================================================
---
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
(original)
+++
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
Wed Apr 25 17:28:37 2012
@@ -101,7 +101,7 @@ Ideally we'd want a +3 from the committe
### 5. Update all references to SNAPSHOT in the properties files and update
the pom-templates
- 1. Find the version reference '*.*.*-incubating-SNAPSHOT' in the following
files. Update it in each case removing the '-SNAPSHOT' at the end, so that it
reads '*.*.*-incubating'
+ 1. Find the version reference in the following files. Update it in each case
removing the '-SNAPSHOT' at the end, so that it reads for example
'0.10.0-incubating'
- /build.properties
- /ivy.xml
@@ -119,23 +119,24 @@ Ideally we'd want a +3 from the committe
- /pom-template.xml
Find...
- <pre>
- <scm>
-
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/trunk</connection>
-
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/trunk/</developerConnection>
- <url>http://svn.apache.org/viewvc/incubator/wookie/trunk/</url>
- </scm>
- </pre>
-
+
+ <scm>
+
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/trunk</connection>
+
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/trunk/</developerConnection>
+ <url>http://svn.apache.org/viewvc/incubator/wookie/trunk/</url>
+ </scm>
+
+
...and update it (with correct version number) to read...
- <pre>
- <scm>
-
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating</connection>
-
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating/</developerConnection>
-
<url>http://svn.apache.org/viewvc/incubator/wookie/tags/*.*.*-incubating/</url>
- </scm>
- </pre>
-
+
+ <scm>
+
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/tags/${project.version}</connection>
+
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/tags/${project.version}/</developerConnection>
+
<url>http://svn.apache.org/viewvc/incubator/wookie/tags/${project.version}/</url>
+ </scm>
+
+ Where ${project.version} is going to be your tag name.
+
Do the same with the following two files...
- /connector/java/pom-template.xml
@@ -175,27 +176,27 @@ Ideally we'd want a +3 from the committe
### 10. Run the build script
- 1. Switch back to the trunk. Run the ant task 'build-release-all' found in
the root build.xml file
+ 1. Switch back to the created tag version. Run the ant task
'build-release-all' found in the root build.xml file
- either use eclipse to run it or use 'ant build-release-all' on the
command line at the wookie root folder
1. This should generate a new folder at the root of wookie called 'release'
containing the following structure...
-<pre>
- release
- + *.*.*-incubating
- + binary
- + standalone
-
apache-wookie-*.*.*-incubating-standalone.tar.gz
-
apache-wookie-*.*.*-incubating-standalone.zip
- rat-report.txt
- + war
-
apache-wookie-*.*.*-incubating-war.tar.gz
-
apache-wookie-*.*.*-incubating-war.zip
- rat-report.txt
- + source
-
apache-wookie-*.*.*-incubating-src.tar.gz
- apache-wookie-*.*.*-incubating-src.zip
- rat-report.txt
- runsignatures.bat
-</pre>
+
+ release
+ ${project.version}-incubating
+ binary
+ standalone
+
apache-wookie-${project.version}-incubating-standalone.tar.gz
+
apache-wookie-${project.version}-incubating-standalone.zip
+ rat-report.txt
+ war
+
apache-wookie-${project.version}-incubating-war.tar.gz
+
apache-wookie-${project.version}-incubating-war.zip
+ rat-report.txt
+ source
+ apache-wookie-${project.version}-incubating-src.tar.gz
+ apache-wookie-${project.version}-incubating-src.zip
+ rat-report.txt
+ runsignatures.bat
+
1. The rat-report.txt files are for your reference and can be removed when
checked.
1. Open a command prompt and run the 'runsignatures.bat' file
- (AUTHOR NOTE: we need to either also supply a .sh version of this or
better still automate it)
@@ -217,11 +218,11 @@ Ideally we'd want a +3 from the committe
1. Make sure you delete the 3 rat-report.txt files (otherwise the next stage
will upload them)
1. From the 'wookie/release' folder run the following to upload the
generated build folder and artifacts...
- scp -r ${project.version}
${user.name}@people.apache.org:/www/people.apache.org/builds/incubator/wookie/
+ scp -r ${project.version}
${user.name}@people.apache.org:/www/people.apache.org/builds/incubator/wookie/
...substituting the ${project.version} with the folder name of the
generated artifacts i.e...
- scp -r ./0.10.0-incubating
[email protected]:/www/people.apache.org/builds/incubator/wookie/
+ scp -r ./0.10.0-incubating
[email protected]:/www/people.apache.org/builds/incubator/wookie/
(Note: the pscp utility comes with putty, rather than scp)
@@ -233,7 +234,7 @@ Ideally we'd want a +3 from the committe
- choose run as -> ant build...
- highlight the "Main" tab and in the "Arguments" panel add the following
- -Duser.name="My Name" -Dupload.user=your_apache_userid
-Dupload.password=your_svn_password -Dpgp.password=your_pgp_password
-Dpgp.keyId=your_pgp_keyid
+ -Duser.name="My Name" -Dupload.user=your_apache_userid
-Dupload.password=your_svn_password -Dpgp.password=your_pgp_password
-Dpgp.keyId=your_pgp_keyid
(substituting your details where applicable)
@@ -243,7 +244,7 @@ Ideally we'd want a +3 from the committe
1. Once again check to make sure the correct LICENSE and NOTICE files appear
in each /META-INF folder found within each archive
1. When you are happy the generated files are okay, either run the following
ant task at the command prompt to deploy to Nexus...
- ant publish-maven-release-artifacts
publish-subproject-artifacts-to-release-repo -Duser.name="My Name"
-Dupload.user=your_apache_userid -Dupload.user=your_apache_userid
-Dupload.password=your_svn_password -Dpgp.password=your_pgp_password
-Dpgp.keyId=your_pgp_keyid
+ ant publish-maven-release-artifacts
publish-subproject-artifacts-to-release-repo -Duser.name="My Name"
-Dupload.user=your_apache_userid -Dupload.user=your_apache_userid
-Dupload.password=your_svn_password -Dpgp.password=your_pgp_password
-Dpgp.keyId=your_pgp_keyid
or if you have completed step (1.) above, simply right click the root
build.xml and choose to run 'publish-maven-release-artifacts' and
'publish-subproject-artifacts-to-release-repo'
(AUTHOR NOTE: we need to merge these ant tasks into 1 call)
@@ -292,7 +293,7 @@ Ideally we'd want a +3 from the committe
1. Copy the release artifacts over to the distribution area
- login to people.apache.org and copy across the build folder
- cp -r /www/people.apache.org/builds/incubator/wookie/*.*.*-incubating
/www/www.apache.org/dist/incubator/wookie
+ cp -r
/www/people.apache.org/builds/incubator/wookie/${project.version}-incubating
/www/www.apache.org/dist/incubator/wookie
(replacing the version name accordingly)
@@ -300,7 +301,7 @@ Ideally we'd want a +3 from the committe
1. Delete the staged version (cleanup)
- login to people.apache.org (if not already) and delete the old staged
release
- rm -rfv /www/people.apache.org/builds/incubator/wookie/*.*.*-incubating
+ rm -rfv
/www/people.apache.org/builds/incubator/wookie/${project.version}-incubating
(replacing the version name accordingly)
@@ -333,11 +334,11 @@ Ideally we'd want a +3 from the committe
1. Delete the svn tag you created in step (7) above. Either use eclipse to
do this or via command prompt
- $ svn del
https://svn.apache.org/repos/asf/incubator/wookie/tags/${project.version} -m
"deleting tag from rolled back release"
+ $ svn del
https://svn.apache.org/repos/asf/incubator/wookie/tags/${project.version} -m
"deleting tag from rolled back release"
1. Delete the build artifacts on people
- $ rm -rfv /www/people.apache.org/builds/incubator/wookie/${project.version}
+ $ rm -rfv
/www/people.apache.org/builds/incubator/wookie/${project.version}
1. Drop the nexus staging repo
- https://repository.apache.org/index.html
Copied:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-testing.mdtext
(from r1306823,
incubator/wookie/site/trunk/content/wookie/docs/developer/releaseTesting.mdtext)
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/release-testing.mdtext?p2=incubator/wookie/site/trunk/content/wookie/docs/developer/release-testing.mdtext&p1=incubator/wookie/site/trunk/content/wookie/docs/developer/releaseTesting.mdtext&r1=1306823&r2=1330430&rev=1330430&view=diff
==============================================================================
---
incubator/wookie/site/trunk/content/wookie/docs/developer/releaseTesting.mdtext
(original)
+++
incubator/wookie/site/trunk/content/wookie/docs/developer/release-testing.mdtext
Wed Apr 25 17:28:37 2012
@@ -18,6 +18,8 @@ Notice: Licensed to the Apache Softwa
These are instructions to help community members with testing new releases.
+TODO - out of date instructions - need to update!
+
# Test Environment
Ideally the client will access from a different network machine to the server.
Propchange:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-testing.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/wookie/site/trunk/templates/sidenav.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/templates/sidenav.mdtext?rev=1330430&r1=1330429&r2=1330430&view=diff
==============================================================================
--- incubator/wookie/site/trunk/templates/sidenav.mdtext (original)
+++ incubator/wookie/site/trunk/templates/sidenav.mdtext Wed Apr 25 17:28:37
2012
@@ -29,6 +29,7 @@
- [Extension Features](/wookie/docs/developer/features.html)
- [Deploying Widgets](/wookie/docs/developer/widgets.html)
- [Environment](/wookie/docs/develop.html)
+ - [Release Management](/wookie/docs/developer/release-management.html)
- [Issue Tracker](/wookie/docs/developer/issues.html)
- [Management](/wookie/docs/developer/index.html)
- [W3C Widget Parser](/wookie/docs/developer/parser.html)
