You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by is...@apache.org on 2013/11/19 20:24:44 UTC
svn commit: r1543536 -
/mahout/site/mahout_cms/trunk/content/developers/how-to-release.mdtext
Author: isabel
Date: Tue Nov 19 19:24:44 2013
New Revision: 1543536
URL: http://svn.apache.org/r1543536
Log:
MAHOUT-1245 - formatting changes to how to release page
Modified:
mahout/site/mahout_cms/trunk/content/developers/how-to-release.mdtext
Modified: mahout/site/mahout_cms/trunk/content/developers/how-to-release.mdtext
URL: http://svn.apache.org/viewvc/mahout/site/mahout_cms/trunk/content/developers/how-to-release.mdtext?rev=1543536&r1=1543535&r2=1543536&view=diff
==============================================================================
--- mahout/site/mahout_cms/trunk/content/developers/how-to-release.mdtext (original)
+++ mahout/site/mahout_cms/trunk/content/developers/how-to-release.mdtext Tue Nov 19 19:24:44 2013
@@ -1,4 +1,8 @@
Title: How To Release
+
+# How To Release Mahout
+
+
*This page is prepared for Mahout committers. You need committer rights to
create a new Mahout release.*
@@ -47,22 +51,23 @@ upcoming version number listed as the "F
<a name="HowToRelease-Makingarelease"></a>
## Making a release
-1. Check if documentation needs an update
-1. Update the web site's news by updating a working copy of the SVN
+* Check if documentation needs an update
+* Update the web site's news by updating a working copy of the SVN
directory at https://svn.apache.org/repos/asf/mahout/site/new_website
-1. Commit these changes. It is important to do this prior to the build so
+* Commit these changes. It is important to do this prior to the build so
that it is reflected in the copy of the website included with the release
for documentation purposes.
-1. If this is your first release, add your key to the KEYS file. The KEYS
+* If this is your first release, add your key to the KEYS file. The KEYS
file is located in Subversion at
https://svn.apache.org/repos/asf/mahout/trunk/distribution/KEYS and copy it
to the release directory. Make sure you commit your change. See
http://www.apache.org/dev/release-signing.html.
-1. Ensure you have set up standard Apache committer settings in
+* Ensure you have set up standard Apache committer settings in
~/.m2/settings.xml as per [this page](http://maven.apache.org/developers/committer-settings.html)
.
-1. Add a profile to your ~/.m2/settings.xml in the <profiles> section with:
- {code}
+* Add a profile to your ~/.m2/settings.xml in the <profiles> section with:
+
+ <blockquote>
<profiles>
<profile>
<id>mahout_release</id>
@@ -77,21 +82,23 @@ http://www.apache.org/dev/release-signin
</properties>
</profile>
</profiles>
+</blockquote>
- # You may also need to add the following to the <servers> section in
+* You may also need to add the following to the <servers> section in
~/.m2/settings.xml in order to upload artifacts (as the -Dusername=
-Dpassword= didn't work for Grant for 0.8, but this did):
-
+<blockquote>
<server>
<id>apache.releases.https</id>
<username>USERNAME</username>
<password>PASSWORD</password>
</server>
+</blockquote>
- # Set environment variable MAVEN_OPTS to -Xmx1024m to ensure the tests can
+* Set environment variable MAVEN_OPTS to -Xmx1024m to ensure the tests can
run
- # export _JAVA_OPTIONS="-Xmx1g"
- # If you are outside the US, then svn.apache.org may not resolve to the
+* export _JAVA_OPTIONS="-Xmx1g"
+* If you are outside the US, then svn.apache.org may not resolve to the
main US-based Subversion servers. (Compare the IP address you get for
svn.apache.org with svn.us.apache.org to see if they are different.) This
will cause problems during the release since it will create a revision and
@@ -99,7 +106,7 @@ then immediately access, but, there is a
minute to the non-US servers. To temporarily force using the US-based
server, edit your equivalent of /etc/hosts and map the IP address of
svn.us.apache.org to svn.apache.org.
- # Create the release candidate: {{mvn -Pmahout_release release:prepare release:perform}}. If you have problems authenticating to svn.apache.org, try adding to the command line {{-Dusername=\[user\]
+* Create the release candidate: {{mvn -Pmahout_release release:prepare release:perform}}. If you have problems authenticating to svn.apache.org, try adding to the command line {{-Dusername=\[user\]
-Dpassword=\[password\]}}. If it screws up, do not clean or release:clean
without first trying to do: release:rollback. This will likely save you
time and do the right thing. If it doesn't work, then do clean and
@@ -107,94 +114,96 @@ release:clean and also delete the tag fr
also have to rollback the version numbers in the POM files.
( If you want to skip test cases while rebuilding, use mvn
-DpreparationGoals="clean compile" release:prepare release:perform)
- # Review the artifacts, etc. on the Apache Repository (using Sonatype's
+* Review the artifacts, etc. on the Apache Repository (using Sonatype's
Nexus application) site: https://repository.apache.org/.
You will need to login using your ASF SVN credentials and then
browse to the staging area.
- # Once you have reviewed the artifacts, you will need to "Close" out
+* Once you have reviewed the artifacts, you will need to "Close" out
the staging area under Nexus, which then makes the artifacts available for
others to see.
- ## Log in to Nexus
- ## Click the Staging Repositories link in the left hand menu
- ## Click the Mahout staged one that was just uploaded by the
+ * Log in to Nexus
+ * Click the Staging Repositories link in the left hand menu
+ * Click the Mahout staged one that was just uploaded by the
release:perform target
- ## Click Close in the toolbar. See
+ * Click Close in the toolbar. See
https://docs.sonatype.org/display/Repository/Closing+a+Staging+Repository
for a picture
- ## Copy the "Repository URL" link to your email; it should be like
+ * Copy the "Repository URL" link to your email; it should be like
https://repository.apache.org/content/repositories/orgapachemahout-024/
- # Call a VOTE on dev@mahout.apache.org. Votes require 3 days before
+* Call a VOTE on dev@mahout.apache.org. Votes require 3 days before
passing. See Apache [release policy|http://www.apache.org/foundation/voting.html#ReleaseVotes]
for more info.
- # If there's a problem, you need to unwind the release and start all
+* If there's a problem, you need to unwind the release and start all
over.
- {panel}
+ <blockquote>
mvn -Pmahout_release versions:set -DnewVersion=PREVIOUS_SNAPSHOT
mvn -Pmahout_release versions:commit
svn commit
svn rm https://svn.apache.org/repos/asf/mahout/tags/mahout-VERSION
- {panel}
- # Release the artifact in the Nexus Repository in the same way you
+ </blockquote>
+* Release the artifact in the Nexus Repository in the same way you
Closed it earlier.
- # Add your key to the KEYS file at
+* Add your key to the KEYS file at
http://www.apache.org/dist/mahout/<version>/
- # Copy the assemblies and their supporting files (tar.gz, zip, tar.bz2,
+* Copy the assemblies and their supporting files (tar.gz, zip, tar.bz2,
plus .asc, .md5, .pom, .sha1 files) to the ASF mirrors at:
people.apache.org:/www/www.apache.org/dist/mahout/<version>/. You should
make sure the group "mahout" owns the files and that they are read only
(-r--r--r-- in UNIX-speak). See [Guide To Distributing Existing Releases Through The ASF Mirrors|http://jakarta.apache.org/site/convert-to-mirror.html?Step-By-Step]
and the links that are there.
- ## cd /www/www.apache.org/dist/mahout
- ## mkdir <VERSION>
- ## cd <VERSION>
- ## wget -e robots=off --no-check-certificate -np -r
+ * cd /www/www.apache.org/dist/mahout
+ * mkdir <VERSION>
+ * cd <VERSION>
+ * wget -e robots=off --no-check-certificate -np -r
https://repository.apache.org/content/groups/public/org/apache/mahout/mahout-distribution/<VERSION>/
- ## mv
+ * mv
repository.apache.org/content/groups/public/org/apache/mahout/mahout-distribution/0.8/*
.
- ## rm -rf repository.apache.org/
- ## rm index.html
- # Wait 24 hours for release to propagate to mirrors.
- # Clean up JIRA: Bulk close all X.Y JIRA issues. Mark the Version
+ * rm -rf repository.apache.org/
+ * rm index.html
+* Wait 24 hours for release to propagate to mirrors.
+* Clean up JIRA: Bulk close all X.Y JIRA issues. Mark the Version
number as being released (see Manage Versions.) Add the next version
(X.Y+1) if necessary.
- # Update release version on http://mahout.apache.org/ and
+* Update release version on http://mahout.apache.org/ and
http://en.wikipedia.org/wiki/Apache_Mahout
- ##
+*
https://cwiki.apache.org/confluence/display/MAHOUT/How+To+Update+The+Website
- # Send announcements to the user and developer lists.
+* Send announcements to the user and developer lists.
- See also:
- * http://maven.apache.org/developers/release/releasing.html
- *
+
+
+See also:
+
+* http://maven.apache.org/developers/release/releasing.html
+*
http://www.sonatype.com/books/nexus-book/reference/staging-sect-deployment.html
- * http://www.sonatype.com/books/nexus-book/reference/index.html
+* http://www.sonatype.com/books/nexus-book/reference/index.html
- h2. Post Release
- h3. Versioning
- * Create the next version in JIRA (if it doesn't already exist)
- * Mark the version as "released" in JIRA (noting the release date)
+
+## Post Release
+### Versioning
+* Create the next version in JIRA (if it doesn't already exist)
+* Mark the version as "released" in JIRA (noting the release date)
- h3. Documentation
- * Change wiki to match current best practices (remove/change deprecations,
+### Documentation
+* Change wiki to match current best practices (remove/change deprecations,
etc)
- h3. Publicity
- * update freshmeat
- * !TheServerSide blurb
- * blog away
- * Update MLOSS entry: http://mloss.org/revision/view/387/. See Grant for
+### Publicity
+* update freshmeat
+* !TheServerSide blurb
+* blog away
+* Update MLOSS entry: http://mloss.org/revision/view/387/. See Grant for
details.
- h1. Related Resources
-
- * http://www.apache.org/dev/#releases
- * http://www.apache.org/dev/#mirror
+## Related Resources
- h1. :TODO: Things To Cleanup in this document
+* http://www.apache.org/dev/#releases
+* http://www.apache.org/dev/#mirror
- *TODO*
-
- * more specifics about things to test before starting or after packaging
+# TODO: Things To Cleanup in this document
+
+* more specifics about things to test before starting or after packaging
(RAT, run scripts against example, etc...)
- * include info about [Voting | http://www.apache.org/foundation/voting.html#ReleaseVotes]
+* include info about [Voting | http://www.apache.org/foundation/voting.html#ReleaseVotes]
\ No newline at end of file