Document and implement the default workflow

michaeljoseph · Sep 3, 2013 · 95e1f5d · 95e1f5d
1 parent c59d263
commit 95e1f5d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -54,9 +54,18 @@ Options:
 
   --pypi=<pypi>         Specify alternative pypi
   --dry-run             Prints the commands that would have been executed.
+  --commit-changelog    Should the automatically generated changelog be 
+                        committed?
   --debug               Debug output.
 ```
 
+The default workflow is to run the `changelog` command to autogenerate
+a changelog entry based on your commit messages.  You're probably going to 
+want to edit that a bit, so `changes` won't commit it, unless you
+`--commit-changelog`.
+
+The remaining tasks can be automated with the `release` command.
+
 ## Documentation
 
 [API Documentation][1]

diff --git a/changes/cli.py b/changes/cli.py
@@ -232,7 +232,6 @@ def upload(arguments):
 
 def release(arguments):
     version(arguments)
-    changelog(arguments)
     tag(arguments)
     upload(arguments)