You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2014/04/25 20:40:46 UTC

git commit: Drop `./cordova-coho/` prefix from docs & suggest `npm link` in README

Repository: cordova-coho
Updated Branches:
  refs/heads/master ac420dd54 -> 03097d5f7


Drop `./cordova-coho/` prefix from docs & suggest `npm link` in README


Project: http://git-wip-us.apache.org/repos/asf/cordova-coho/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-coho/commit/03097d5f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-coho/tree/03097d5f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-coho/diff/03097d5f

Branch: refs/heads/master
Commit: 03097d5f7bc77f456a576bf62c3307300fb51a53
Parents: ac420dd
Author: Andrew Grieve <ag...@chromium.org>
Authored: Fri Apr 25 14:39:07 2014 -0400
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Fri Apr 25 14:39:07 2014 -0400

----------------------------------------------------------------------
 README.md                        |  6 +++--
 docs/cadence-release-process.md  | 42 +++++++++++++++++------------------
 docs/plugins-release-process.md  | 28 +++++++++++------------
 docs/processing-pull-requests.md |  6 ++---
 docs/setting-up-gpg.md           |  2 +-
 docs/tools-release-process.md    | 14 ++++++------
 6 files changed, 50 insertions(+), 48 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/03097d5f/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 80cbafd..fbcb43f 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,10 @@ This repository has the following purposes:
   - e.g. coho repo-clone
   - e.g. coho --help
 
-## How to Clone & Use
+## How to Clone & Use `coho`
 
     mkdir -p cordova && cd cordova && git clone https://git-wip-us.apache.org/repos/asf/cordova-coho.git
-    cordova-coho/coho --help
+    npm install
+    npm link
+    coho --help
 

http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/03097d5f/docs/cadence-release-process.md
----------------------------------------------------------------------
diff --git a/docs/cadence-release-process.md b/docs/cadence-release-process.md
index 89c44a2..c8eb994 100644
--- a/docs/cadence-release-process.md
+++ b/docs/cadence-release-process.md
@@ -16,7 +16,7 @@ TODO: We may want to be using [signed tags](http://git-scm.com/book/en/Git-Basic
 
 Create the release bug for the Release Candidate:
 
-    ./cordova-coho/coho create-release-bug --version=3.0.0 --username=JiraUser --password=JiraPassword
+    coho create-release-bug --version=3.0.0 --username=JiraUser --password=JiraPassword
 
 This bug contains subtasks for each top-level step involved in creating a release.
 ***For each completed step, add a comment to the relevant JIRA issue.***
@@ -32,11 +32,11 @@ This step involves:
 
 Coho automates these steps:
 
-    ./cordova-coho/coho prepare-release-branch --version 2.8.0-rc1 -r js -r app-hello-world -r mobile-spec
-    ./cordova-coho/coho repo-status -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
+    coho prepare-release-branch --version 2.8.0-rc1 -r js -r app-hello-world -r mobile-spec
+    coho repo-status -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
     # If changes look right:
-    ./cordova-coho/coho repo-push -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
-    ./cordova-coho/coho tag-release --version 2.8.0-rc1 -r js -r app-hello-world -r mobile-spec
+    coho repo-push -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
+    coho tag-release --version 2.8.0-rc1 -r js -r app-hello-world -r mobile-spec
 
 If the JS ever needs to be re-tagged, rerun the `tag-release` command, and then re-run the `prepare-release-branch` command for the platform repos.
 
@@ -45,7 +45,7 @@ If the JS ever needs to be re-tagged, rerun the `tag-release` command, and then
 ### Before creating the release branch:
 
  1. Run [Apache RAT](http://creadur.apache.org/rat/) to ensure copyright headers are present
-   * `./cordova-coho/coho audit-license-headers -r android | less`
+   * `coho audit-license-headers -r android | less`
  2. Update the copy of app-hello-world (if there were any changes to it)
    * This usually lives within bin/templates somewhere
    * TODO: More details needed here
@@ -73,11 +73,11 @@ This step involves:
 
 Coho automates these steps (replace android with your platform):
 
-    ./cordova-coho/coho prepare-release-branch --version 2.8.0-rc1 -r android
-    ./cordova-coho/coho repo-status -r android -b master -b 2.8.x
+    coho prepare-release-branch --version 2.8.0-rc1 -r android
+    coho repo-status -r android -b master -b 2.8.x
     # If changes look right:
-    ./cordova-coho/coho repo-push -r android -b master -b 2.8.x
-    ./cordova-coho/coho tag-release --version 2.8.0-rc1 -r android
+    coho repo-push -r android -b master -b 2.8.x
+    coho tag-release --version 2.8.0-rc1 -r android
 
 ## Tagging RC1 of cordova-cli
 
@@ -119,17 +119,17 @@ To submit a fix:
    * Ensure generated project builds & runs both through an IDE and through the cordova/* scripts
  * Test Project Upgrades (old-style):
    1. Create a project using the previous version of cordova
-     * `./cordova-coho/coho foreach "git checkout 2.9.0"`
-     * `./cordova-coho/coho foreach -r active-platform "./bin/create foo org.apache.foo foo"`
+     * `coho foreach "git checkout 2.9.0"`
+     * `coho foreach -r active-platform "./bin/create foo org.apache.foo foo"`
    2. Upgrade the project via the bin/update_project script:
-     * `./cordova-coho/coho foreach "git checkout 3.0.x"`
-     * `./cordova-coho/coho foreach -r active-platform "cd foo && ../bin/update_project"`
+     * `coho foreach "git checkout 3.0.x"`
+     * `coho foreach -r active-platform "cd foo && ../bin/update_project"`
    3. Test the result:
      * Project should run
      * cordova/version should report the new version
  * Test Project Upgrades (new-style):
    1. Create a project using the previous version of cordova
-     * `./cordova-coho/coho foreach "git checkout 2.9.0"`
+     * `coho foreach "git checkout 2.9.0"`
      * `./cordova-mobile-spec/createmobilespec.sh`
    2. Upgrade the project via the update command:
      * `../cordova-cli/bin/cordova platform update PLATFORM`
@@ -174,11 +174,11 @@ This is done for all repos once testing is complete, and documentation is up-to-
 
 Use the same coho commands as for the RCs (it will update JS & VERSION):
 
-    ./cordova-coho/coho prepare-release-branch --version 2.8.0 -r js -r app-hello-world -r mobile-spec
-    ./cordova-coho/coho repo-status -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
+    coho prepare-release-branch --version 2.8.0 -r js -r app-hello-world -r mobile-spec
+    coho repo-status -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
     # If changes look right:
-    ./cordova-coho/coho repo-push -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
-    ./cordova-coho/coho tag-release --version 2.8.0 -r js -r app-hello-world -r mobile-spec
+    coho repo-push -r js -r app-hello-world -r mobile-spec -b master -b 2.8.x
+    coho tag-release --version 2.8.0 -r js -r app-hello-world -r mobile-spec
 
 ## Branching & Tagging cordova-docs
 
@@ -281,11 +281,11 @@ The `/cordova-VERSION-src.zip/` is the official release artifact and contains th
 
 Create the release .zip with coho:
 
-    ./cordova-coho/coho create-release-snapshot --prev-version 2.7.0 --new-version 2.8.0-rc1 -r release-repos
+    coho create-release-snapshot --prev-version 2.7.0 --new-version 2.8.0-rc1 -r release-repos
 
 Upload it to: https://dist.apache.org/repos/dist/release/cordova/
 
-    ./cordova-coho/coho upload-release --new-version 3.0.0 --prev-version 2.9.0
+    coho upload-release --new-version 3.0.0 --prev-version 2.9.0
 
 [Update the versions](https://wiki.apache.org/cordova/UpdatingVersionsOnTheCordovaWebsite) on the Cordova website
 

http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/03097d5f/docs/plugins-release-process.md
----------------------------------------------------------------------
diff --git a/docs/plugins-release-process.md b/docs/plugins-release-process.md
index cefa8bf..036a478 100644
--- a/docs/plugins-release-process.md
+++ b/docs/plugins-release-process.md
@@ -41,26 +41,26 @@ TODO: Should not mention testing other than checking medic
 ## Make sure you're up-to-date
 
     # Update your repos
-    ./cordova-coho/coho repo-status -r plugins -b dev -b master
-    ./cordova-coho/coho repo-update -r plugins
-    ./cordova-coho/coho foreach -r plugins "git checkout dev"
+    coho repo-status -r plugins -b dev -b master
+    coho repo-update -r plugins
+    coho foreach -r plugins "git checkout dev"
 
     # Merge any commits mistakenly made to master into dev:
     (for l in cordova-plugin-*; do ( cd $l; git merge master ); done
 
     # Sanity check and push if needed:
-    ./cordova-coho/coho repo-status -r plugins -b dev
-    ./cordova-coho/coho repo-push -r plugins -b dev
+    coho repo-status -r plugins -b dev
+    coho repo-push -r plugins -b dev
 
 ## Identify which plugins have changes
 
-    ./cordova-coho/coho repo-update -r plugins
-    ./cordova-coho/coho foreach -r plugins "git checkout dev"
+    coho repo-update -r plugins
+    coho foreach -r plugins "git checkout dev"
     ACTIVE=$(for l in cordova-plugin-*; do ( cd $l; git log --pretty=format:'* %s' --topo-order --no-merges master..dev | grep -v "Incremented plugin version" > /dev/null && echo $l); done | xargs echo)
 
 ## Ensure license headers are present everywhere:
 
-    ./cordova-coho/coho audit-license-headers -r plugins | less
+    coho audit-license-headers -r plugins | less
 
 ## Update RELEASENOTES.md & Version
 Remove the ''-dev'' suffix on the version in plugin.xml.
@@ -102,24 +102,24 @@ Commit these two changes together to the `dev` branch
 
 ## Push Dev Branch
     # Sanity check:
-    ./cordova-coho/coho repo-status -r plugins -b dev
+    coho repo-status -r plugins -b dev
     # Push:
     for l in $ACTIVE; do ( cd $l; git push --tags https://git-wip-us.apache.org/repos/asf/$l.git dev); done
 
 ## Publish to dist/dev
 Ensure you have the svn repos checked out:
 
-    ./cordova-coho/coho repo-clone -r dist -r dist/dev
+    coho repo-clone -r dist -r dist/dev
 
 Create archives from your tags:
 
-    ./cordova-coho/coho create-archive -r ${ACTIVE// / -r } --dest cordova-dist-dev/$JIRA
+    coho create-archive -r ${ACTIVE// / -r } --dest cordova-dist-dev/$JIRA
 
 Sanity Check:
 
     # Manually double check version numbers are correct on the file names
     # Then run:
-    ./cordova-coho/coho verify-archive cordova-dist-dev/$JIRA/*.zip
+    coho verify-archive cordova-dist-dev/$JIRA/*.zip
 
 Upload:
 
@@ -149,7 +149,7 @@ __Body:__
     https://dist.apache.org/repos/dist/dev/cordova/CB-XXXX/
 
     The packages were published from their corresponding git tags:
-    PASTE OUTPUT OF: ./cordova-coho/coho print-tags -r ${ACTIVE// / -r }
+    PASTE OUTPUT OF: coho print-tags -r ${ACTIVE// / -r }
 
     Upon a successful vote I will upload the archives to dist/, upload them to the Plugins Registry, and post the corresponding blog post.
 
@@ -189,7 +189,7 @@ _Note: list of PMC members: http://people.apache.org/committers-by-project.html#
     for l in $ACTIVE; do ( cd $l; v=$(git describe --tags --abbrev=0 dev); git merge $v ); done
 
     # Sanity check:
-    ./cordova-coho/coho repo-status -r plugins -b master
+    coho repo-status -r plugins -b master
     # Push:
     for l in $ACTIVE; do ( cd $l; git push --tags https://git-wip-us.apache.org/repos/asf/$l.git master); done
 

http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/03097d5f/docs/processing-pull-requests.md
----------------------------------------------------------------------
diff --git a/docs/processing-pull-requests.md b/docs/processing-pull-requests.md
index 0230683..5d998ce 100644
--- a/docs/processing-pull-requests.md
+++ b/docs/processing-pull-requests.md
@@ -8,15 +8,15 @@ Find what requests need attention by looking a the GitHub page.
 
 To look at them in aggregate:
 
-    ./cordova-coho/coho list-pulls | tee pulls.list | less -R
+    coho list-pulls | tee pulls.list | less -R
 
 To filter out those that you last commented on:
 
-    ./cordova-coho/coho list-pulls --hide-user=agrieve
+    coho list-pulls --hide-user=agrieve
 
 To show only certain repos:
 
-    ./cordova-coho/coho list-pulls -r js -r android -r plugin-inappbrowser
+    coho list-pulls -r js -r android -r plugin-inappbrowser
 
 ## Step 1: Review the change (part 1)
  * Ensure that we actually want the change (if unsure, bring it up on the ML)

http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/03097d5f/docs/setting-up-gpg.md
----------------------------------------------------------------------
diff --git a/docs/setting-up-gpg.md b/docs/setting-up-gpg.md
index 36c1604..9c944fb 100644
--- a/docs/setting-up-gpg.md
+++ b/docs/setting-up-gpg.md
@@ -27,7 +27,7 @@ In this example, `8A496450` is your `$KEY_ID`
 Publish to `dist/KEYS`:
 
     # Clone if you don't have it already:
-    ./cordova-coho/coho repo-clone -r dist
+    coho repo-clone -r dist
     gpg --armor --export $KEY_ID >> cordova-dist/KEYS
     # Make sure that's the only change to the file
     ( cd cordova-dist && svn diff )

http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/03097d5f/docs/tools-release-process.md
----------------------------------------------------------------------
diff --git a/docs/tools-release-process.md b/docs/tools-release-process.md
index 538202a..837db7d 100644
--- a/docs/tools-release-process.md
+++ b/docs/tools-release-process.md
@@ -30,12 +30,12 @@ Email the dev mailing-list and see if anyone has reason to postpone the release.
 ## Test
 Ensure license headers are present everywhere:
 
-    ./cordova-coho/coho audit-license-headers -r cli | less
-    ./cordova-coho/coho audit-license-headers -r plugman | less
+    coho audit-license-headers -r cli | less
+    coho audit-license-headers -r plugman | less
 
 Ensure you're up-to-date:
 
-    ./cordova-coho/coho repo-update -r cli -r plugman
+    coho repo-update -r cli -r plugman
     (cd cordova-plugman && npm install)
     (cd cordova-cli && npm install)
     (cd cordova-cli && npm install ../cordova-plugman)
@@ -121,15 +121,15 @@ If the push fails due to not being fully up-to-date, either:
 ## Publish to dist/dev
 Ensure you have the svn repos checked out:
 
-    ./cordova-coho/coho repo-clone -r dist -r dist/dev
+    coho repo-clone -r dist -r dist/dev
 
 Create archives from your tags:
 
-    ./cordova-coho/coho create-archive -r plugman -r cli --dest cordova-dist-dev/$JIRA
+    coho create-archive -r plugman -r cli --dest cordova-dist-dev/$JIRA
 
 Sanity Check:
 
-    ./cordova-coho/coho verify-archive cordova-dist-dev/$JIRA/*.zip
+    coho verify-archive cordova-dist-dev/$JIRA/*.zip
 
 Upload:
 
@@ -160,7 +160,7 @@ __Body:__
     https://dist.apache.org/repos/dist/dev/cordova/CB-XXXX/
 
     The packages were published from their corresponding git tags:
-    PASTE OUTPUT OF: ./cordova-coho/coho print-tags -r plugman -r cli
+    PASTE OUTPUT OF: coho print-tags -r plugman -r cli
 
     Upon a successful vote I will upload the archives to dist/, publish them to NPM, and post the corresponding blog post.