README.md in thor-scmversion-0.3.1 vs README.md in thor-scmversion-1.0.0
- old
+ new
@@ -44,13 +44,31 @@
$ thor list
version
-------
- thor version:bump TYPE # Bump version number (type is major, minor, patch or auto)
+ thor version:bump TYPE [PRERELEASE_TYPE] # Bump version number (type is major, minor, patch, prerelease or auto)
+ # Prerelease allows an additional parameter to be passed which is used
+ # as the prerelease type.
thor version:current # Show current SCM tagged version
+Usage Examples:
+ $ thor version:current
+ 1.2.1
+ $ thor version:bump auto
+ 1.2.2
+ $ thor version:bump major
+ 2.0.0
+ $ thor version:bump prerelease
+ 2.0.1-alpha.1
+ $ thor version:bump prerelease
+ 2.0.1-alpha.2
+ $ thor version:bump prerelease beta
+ 2.0.1-beta.1
+ $ thor version:bump minor
+ 2.1.0
+
### Remove your VERSION file from source control
Since your CI server will be managing your VERSION file, you don't
want it to be stored in your SCM anymore. Make a note of your current
version, then
@@ -75,26 +93,27 @@
Now, as part of your CI job, before it builds your artifacts, have it
run `thor version:bump patch`. This will increment the patch, push the
new tag, and write the VERSION file. Now the artifact you build will
have the right version information, every time.
-### You manage the major and minor
+### You manage the major, minor patch and prerelease
-When you make significant changes, you can bump the major or minor
+When you make significant changes, you can bump the major, minor or patch
number yourself with `thor version:bump minor`. This will create a tag
with a .0 patch level, so the next build made by the server will be
.1 patch level.
### Auto bumping
-If you include #major or #minor in the subject of commits, and run
-`thor version:bump auto` it will see if any major or minor level changes
+If you include #major, #minor or #patch in the subject of commits, and run
+`thor version:bump auto` it will see if any major, minor or patch level changes
are included since the last tag, and use the appropriate version. This works
especially well with a CI server, allowing you to never have to directly
-manage versions at all.
+manage versions at all. If no commits are tagged, the build number for the
+current version will be bumped instead.
NOTE: auto bumping currently only works for Git repos. For Perforce repos,
-auto is the same as patch.
+auto is the same as build.
## Contributing
1. Fork it