accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bhava...@apache.org
Subject svn commit: r1573608 - /accumulo/site/trunk/content/releasing.mdtext
Date Mon, 03 Mar 2014 16:47:54 GMT
Author: bhavanki
Date: Mon Mar  3 16:47:53 2014
New Revision: 1573608

URL: http://svn.apache.org/r1573608
Log:
Minor edits

Modified:
    accumulo/site/trunk/content/releasing.mdtext

Modified: accumulo/site/trunk/content/releasing.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/content/releasing.mdtext?rev=1573608&r1=1573607&r2=1573608&view=diff
==============================================================================
--- accumulo/site/trunk/content/releasing.mdtext (original)
+++ accumulo/site/trunk/content/releasing.mdtext Mon Mar  3 16:47:53 2014
@@ -22,8 +22,8 @@ This is a guide for the creation of a re
 
 There are number of things that are required before attempting to build a release.
 
-1. Use gpg-agent, be sure to increase the gpg-agent cache timeout (via .gnupg/gpg-agent.conf)
to ensure that the agent doesn't require re-authentication mid-build as it will cause things
to fail. For example, you can add `default-cache-ttl 6000` to increase the timeout from the
default of 10 minutes to over an hour. If you do not have a GPG key, reference the very thorough
[ASF release signing documentation][1]
-2. Make sure the system you're using is able to creation RPMs and DEBs.
+1. Use gpg-agent, and be sure to increase the gpg-agent cache timeout (via .gnupg/gpg-agent.conf)
to ensure that the agent doesn't require re-authentication mid-build, as it will cause things
to fail. For example, you can add `default-cache-ttl 6000` to increase the timeout from the
default of 10 minutes to over an hour. If you do not have a GPG key, reference the very thorough
[ASF release signing documentation][1].
+2. Make sure the system you're using is able to create RPMs and DEBs.
 3. Ensure that you're using the correct major release of Java (check javadoc too).
 4. Ensure that you're building Apache Accumulo with a username that has the same name as
your Apache ID (this is due to
    the maven-release-plugin and staging the release candidate).
@@ -48,29 +48,29 @@ it was agreed upon to omit issues from p
 You should use the provided script assemble/build.sh to create the release candidate. This
script is
 desirable as it activates all necessary maven profiles in addition to verifying that certain
preconditions
 are met, like RPM signing availablilty and the ability to sign files using GPG. The --test
option can 
-be used as a dry-run to creating a release candidate. The --create-release-candidate option
should be 
-provided to create the actual release candidate.
+be used as a dry run for creating a release candidate. The --create-release-candidate option
should be 
+used to create the actual release candidate.
 
 When invoking build.sh with the --create-release-candidate option, the majority of the work
will be performed
-by the maven-release-plugin, invoking release:clean, release:prepare, and release:perform.
These will
+by the maven-release-plugin, invoking *release:clean*, *release:prepare*, and *release:perform*.
These will
 guide you through choosing the correct versions. The default options provided should be what
you choose.
-It is highly recommended that an 'RC' suffix is *not* appended to the release version the
the plugin prompts
-you for as that will result in that version string being placed into the poms which then
would require 
+It is highly recommended that an 'RC' suffix is *not* appended to the release version the
plugin prompts
+you for, as that will result in that version string being placed into the poms, which then
would require 
 voting to occur on artifacts that cannot be directly promoted. After the build.sh script
finishes (this will 
 likely take at least 15 minutes, even on recent hardware), your current branch will be on
the "next" version 
 that you provided to the release plugin.
 
-Likely, this process will actually fail because the maven-release-plugin is not configured
to push to the 
-remote repository automatically, and thus, will fail; however, this is (semi-)expected. At
this point, you
-should have a local git-tag for the release that you're creating. At this point, you should
create a branch
+This process is likely to fail because the maven-release-plugin is not configured to push
to the 
+remote repository automatically; however, this is (semi-)expected. At this point, you
+should have a local git tag for the release that you're creating. You should create a branch
 from the tag that was made by the release plugin which includes the _-rcN_ suffix. This way,
the branch name 
-will correctly identify which release-candidate this is, while the contents of that tag will
have the correct 
+will correctly identify which release candidate this is, while the contents of that tag will
have the correct 
 versions in the pom.xml files. This also ensure that the _release:perform_ goal of the release
plugin will
 work as intended.
 
-One unwanted side-effect of this approach is that after creating this branch, but *before
invoking _release:perform_*,
+One unwanted side-effect of this approach is that after creating this branch, but *before
invoking release:perform*,
 you must edit the release.properties to add the _-rcN_ suffix to the value of scm.tag. Otherwise,
the release
-plugin will complain that it cannot find the branch for the release. A successful invocation
of _mvn release:perform_,
+plugin will complain that it cannot find the branch for the release. With a successful invocation
of *mvn release:perform*,
 a staging repository will be made for you on the [ASF Nexus server][2] which you can log
into with your ASF 
 credentials.
 
@@ -82,13 +82,13 @@ will make it publicly available for othe
 
 ## Vote
 
-At this point, you should have a closed repository that's ready to vote on. Send a message
to the [the dev
+At this point, you should have a closed repository that's ready to vote on. Send a message
to [the dev
 list](mailto:dev@accumulo.apache.org) and get the ball rolling. If the vote ultimately fails,
you delete
 the staged repository, clean up the branch you created (or wait until the release ultimately
passes if you
 choose), and fix what needs fixing.
 
 If the vote passes, huzzah, you're almost done. All you need to do is to promote that stage
repository
-using Nexus which you can do with the click of a button. These will trigger a process to
get the release
+using Nexus which you can do with the click of a button. This will trigger a process to get
the release
 out to all of the mirrors.
 
 ## Update the Website
@@ -97,7 +97,7 @@ After a successful vote, this website ne
 be updated with the new information. A new minor release should replace the previous minor
release in the major
 version. The Javadocs should be updated, with special care being taken to ensure that Javadocs
are [patched][7] **before**
 uploading as long as Java 6 is the version targeted by Accumulo (with greater than Java 7u21
being used once we
-switch to Java7). The user manual should also be updated if changes were made to it.
+switch to Java 7). The user manual should also be updated if changes were made to it.
 
 ## References
 



Mime
View raw message