Return-Path: X-Original-To: apmail-curator-commits-archive@minotaur.apache.org Delivered-To: apmail-curator-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 62A7F10188 for ; Wed, 24 Apr 2013 19:05:42 +0000 (UTC) Received: (qmail 87756 invoked by uid 500); 24 Apr 2013 19:05:42 -0000 Delivered-To: apmail-curator-commits-archive@curator.apache.org Received: (qmail 87728 invoked by uid 500); 24 Apr 2013 19:05:42 -0000 Mailing-List: contact commits-help@curator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@curator.apache.org Delivered-To: mailing list commits@curator.apache.org Received: (qmail 87715 invoked by uid 99); 24 Apr 2013 19:05:42 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 24 Apr 2013 19:05:42 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED,RP_MATCHES_RCVD X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO mail.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with SMTP; Wed, 24 Apr 2013 19:05:38 +0000 Received: (qmail 85157 invoked by uid 99); 24 Apr 2013 19:05:16 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 24 Apr 2013 19:05:16 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 50CB888010F; Wed, 24 Apr 2013 19:05:16 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: randgalt@apache.org To: commits@curator.incubator.apache.org Message-Id: <25fb6a164499497aa9b70ddcbbc86384@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: git commit: moved some pages to the wiki Date: Wed, 24 Apr 2013 19:05:16 +0000 (UTC) X-Virus-Checked: Checked by ClamAV on apache.org Updated Branches: refs/heads/master 8a77e57c8 -> bd79f9f68 moved some pages to the wiki Project: http://git-wip-us.apache.org/repos/asf/incubator-curator/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-curator/commit/bd79f9f6 Tree: http://git-wip-us.apache.org/repos/asf/incubator-curator/tree/bd79f9f6 Diff: http://git-wip-us.apache.org/repos/asf/incubator-curator/diff/bd79f9f6 Branch: refs/heads/master Commit: bd79f9f68050bd24e6dd370fdda971754887867d Parents: 8a77e57 Author: randgalt Authored: Wed Apr 24 12:05:06 2013 -0700 Committer: randgalt Committed: Wed Apr 24 12:05:06 2013 -0700 ---------------------------------------------------------------------- src/site/confluence/committers.confluence | 163 -------------------- src/site/confluence/email-examples.confluence | 54 ------- src/site/site.xml | 3 +- 3 files changed, 2 insertions(+), 218 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/bd79f9f6/src/site/confluence/committers.confluence ---------------------------------------------------------------------- diff --git a/src/site/confluence/committers.confluence b/src/site/confluence/committers.confluence deleted file mode 100644 index 1fb369c..0000000 --- a/src/site/confluence/committers.confluence +++ /dev/null @@ -1,163 +0,0 @@ -h1. Information/Recipes for Curator Committers - -*Tools/Preparation* -* [Tools|#tool-chain] -* [GPG|#gpg] -* [Maven Settings|#maven-settings] -* [Git Setup|#git-setup] - -*Development* -* [GitHub Flow|#github-flow] -* [Jira|#use-jira] -* [Maven Checks|maven-checks] - -*Release/Publishing* -* [Prepare for Release|#release-prepare] -* [Perform the Release|#release-perform] -* [Vote On the Release|#release-vote] -* [Promote the Release|#release-promote] -* [How to Publish the Curator Website|#publish-website] - -{anchor:tool-chain} -h2. Tools -Curator is built using Maven and Git. You should be familiar with both of these tools. For publishing, -you also need to install GPG and create a key that is available from a well known public site. - -{anchor:gpg} -h2. GPG -Download GPG from [http://www.gnupg.org/download/]. Then, follow the steps described -here, [http://www.sonatype.com/people/2010/01/how-to-generate-pgp-signatures-with-maven/], to -*Generate a Key Pair* and *Distribute Your Public Key*. - -{anchor:maven-settings} -h2. Maven Settings - -Your Maven settings ({{~/.m2/settings.xml}}) file should have the following (note: -{{curator-website-checkout-path}} is used as a temporary path when deploying the Curator -website): - -{noformat} - - ... - - ... - - apache.website.svnpub - Your Apache Username - ${user.home}/.ssh/id_rsa - - ... - - - - - - ... - path-goes-here - id-of-your-pgp-key - ... - - ... - - ... - - ... - -{noformat} - -{anchor:git-setup} -h2. Git Setup - -Apache has a good guide on how to prepare your environment for interacting with the Curator Git repo: [https://git-wip-us.apache.org/]. - ----- - -h2. Development - -{anchor:github-flow} -h3. GitHub Flow - -Curator loosely uses [GitHub Flow|http://scottchacon.com/2011/08/31/github-flow.html]. The short form of GitHub Flow is: - -* Anything in the master branch is deployable -* To work on something new, create a descriptively named branch off of master (ie: new-oauth2-scopes) -* Commit to that branch locally and regularly push your work to the same named branch on the server -* When you need feedback or help, or you think the branch is ready for merging, send a pull request -* After someone else has reviewed and signed off on the feature, you can merge it into master -* Once it is merged and pushed to 'master', you can and should deploy immediately - -{anchor:use-jira} -h3. Jira - -For all but minor changes, there should be a Jira "ticket" created at [https://issues.apache.org/jira/browse/CURATOR]. - -{anchor:maven-checks} -h3. Maven Checks -Regardless of which IDE you use, you should periodically perform a {{mvn clean install}} to validate that the various configured checks (such as license headers, -etc.) are passing as well as the unit tests. - ----- - -{anchor:release-prepare} -h2. Prepare the Release - -# Do a dry run of the release/prepare step by executing {{mvn release:prepare -DdryRun=true}}. The dry run will not commit any changes back to Git and gives you the opportunity to verify that the release process will complete -as expected. If you need to cancel, execute {{mvn release:clean}} and then reset via {{git reset --hard}}. -# Verify that the release process completed as expected: -** The release plugin will create {{pom.xml.tag}} files which contain the changes that would have been committed to SVN. The only differences between {{pom.xml.tag}} -and its corresponding {{pom.xml}} file should be the version number. -** If other formatting changes have been made you should review the changes and then commit and push them. -** Once any failures or required updates have been committed to svn, rollback the release prepare files: {{mvn release:rollback}} -# Execute the release/prepare step for real this time. You'll be prompted for the same version information and optionally your GPG -passphrase again: {{mvn release:prepare}}. - -{anchor:release-perform} -h2. Perform the Release - -# Execute release/perform: {{release:perform}}. -# Verify the staged artifacts in the Apache Nexus repository: -** Go to: [https://repository.apache.org/index.html] -** Enterprise > Staging -** Staging tab > Name column > curator -** Navigate through the artifact tree and double check things. -# Close the Nexus staging repo by clicking on the curator repo and clicking the "Close" button. -# Important: Do *not* release the repo at this point. Releases require voting. - -{anchor:release-vote} -h2. Initiate a Vote On the Release -# Create a VOTE email thread on dev@curator.incubator.apache.org to record votes as replies (see [Example Emails|email-examples.html]). -# If the Vote succeeds, you can then promote the release: -** At [https://repository.apache.org] select the curator repo and click the "Release" button. -** More TBD -# Regardless of the vote result, send a RESULT VOTE email (see [Example Emails|email-examples.html]). - -{anchor:release-promote} -h2. Promote the Release -Upon a successful vote for the release, it should be promoted: -# Release the artifact: -** Go to: [https://repository.apache.org/index.html] -** Select the curator release and click the "Release" button. -# Deploy the component site: -** TBD -# Add the distribution artifacts to the distribution area: -** TBD -# Announce the Release: -** TBD - ----- - -{anchor:publish-website} -h2. How to Publish the Curator Website - -Assuming you have a clean compile/install of Curator, from the root of the Curator directory: - -{noformat} -mvn site site:stage -{noformat} - -Have a look at the staged site and make sure it's good. Then: - -{noformat} -mvn site-deploy -{noformat} - http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/bd79f9f6/src/site/confluence/email-examples.confluence ---------------------------------------------------------------------- diff --git a/src/site/confluence/email-examples.confluence b/src/site/confluence/email-examples.confluence deleted file mode 100644 index 35a7024..0000000 --- a/src/site/confluence/email-examples.confluence +++ /dev/null @@ -1,54 +0,0 @@ -h1. Example Emails - -h2. Release Vote Email Example - -{noformat} -To: "Apache Curator Developers List" -Subject: [VOTE] Release Curator x.y.z - -Hello, - -This is a vote to release Curator x.y.z - -Link to release notes: -https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314425&version=12324259 - -Staging repo: -https://repository.apache.org/content/repositories/curator-[YOUR REPOSITORY ID]/etc - -Release artifact: -https://repository.apache.org/content/repositories/curator-[YOUR REPOSITORY ID]/etc - -Vote will be open for 72 hours. - -[ ] +1 -[ ] 0 -[ ] -1 (explain why) -{noformat} - -h2. Release Vote Result Email - -{noformat} -To: "Apache Curator Developers List" -Subject: [RESULT] [VOTE] Release Curator x.y.z - -Hello, - -The vote to release Curator x.y.z has passed/failed. - -+1 (binding): - - Jordan Zimmerman (*) - Patrick Hunt (*) - Jay Zarfoss (*) - John Galt - -* IPMC members - -+1 (non binding): - - Ryan Giggs - Wayne Rooney - -I will promote the artifacts to the central repo. -{noformat} http://git-wip-us.apache.org/repos/asf/incubator-curator/blob/bd79f9f6/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 4d8ef9a..d96ab70 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -80,6 +80,7 @@ + @@ -92,7 +93,7 @@ - +