Merge pull request #96 from 4-20ma/update-publish-docs

Update PUBLISH document

PUBLISH.md

@@ -2,47 +2,24 @@
 
 Instructions for publishing this cookbook to the Chef Supermarket:
 
-- Update `metadata.rb` with new cookbook version
+- Select appropriate chef environment
 
-        version           '2.0.1'
+        $ chefvm use chef.io
 
-- Ensure all tests pass
+- Ensure all style/specs pass
 
         $ rake
 
-- Update `CHANGELOG.md` with recent changes
-
-        $ rake changelog[v2.0.0] # use version of most-recent release tag
-
-    - Prepend contents of `changelog.tmp` to `CHANGELOG.md`
-    - Replace `HEAD` with current version number (match `metadata.rb` version)
-    - Replace `YYYY-MM-DD` with current date, if necessary
-    - For each commit line item:
-        - Remove `Fix #xx ` string (regex: `Fix #\d+\s`)
-        - Replace `TYPE` with one of:
-          `BREAK`   - breaking changes
-          `FIX`     - bug fix
-          `IMPROVE` - improvement of existing feature
-          `NEW`     - new feature
-    - Remove `changelog.tmp`
-
-- Commit changes to `metadata.rb` and `CHANGELOG.md`
-
-        $ git add metadata.rb CHANGELOG.md
-        $ git commit -m 'Update changelog, bump version'
-        $ git push
+- Update `CHANGELOG.md` with recent changes; adjust wording of Issues and Pull Requests and re-run as required.
 
-- Ensure working directory is clean; add/stash changes, if necessary
-
-        $ git add . && git stash
-
-- Select appropriate chef environment
-
-        $ chefvm use chef.io
+        $ rake changelog
 
-- Publish cookbook
+- Publish cookbook (select revision, minor, major, or no version bump)
 
-        $ rake publish
+        $ rake publish        # revision version bump, tag, publish
+        $ rake publish:minor  # minor version bump, tag, publish
+        $ rake publish:major  # major version bump, tag, publish
+        # rake publish:now    # use existing version, tag, publish
 
 
 ## Config reference

rakelib/publish.rake

@@ -34,7 +34,7 @@ require 'rake'
 # $ rake publish:minor        # new functionality; backwards-compatible manner
 # $ rake publish:major        # incompatible API changes
 # $ rake publish:now          # publish without version bump
-# $ rake publish:tag          # tag publishment as current version
+# $ rake publish:tag          # tag deployment as current version
 # $ rake publish:supermarket  # publish cookbook(s) to Chef supermarket
 
 #--------------------------------------------------------------------- publish