Add pre-release and build options. (#27)

Author: markchalloner

.git-semver/plugins/keepachangelog.sh

@@ -22,6 +22,12 @@ function run() {
     local version_new_actual="[${version_new}]"
     local version_previous=
 
+    # If the new version just has build information then skip the check
+    if [ "${version_new%+*}" == "${version_current%+*}" ]
+    then
+        return ${status}
+    fi
+
     # If there is no existing version relax rules slightly
     if [ "" == "${version_current}" ]
     then

CHANGELOG.md

@@ -1,9 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-This file uses change log convention from [Keep a CHANGELOG](http://keepachangelog.com).
+This project adheres to [Semantic Versioning].
+This file uses change log convention from [Keep a CHANGELOG].
 
 ## [Unreleased][unreleased]
+### Added
+- Added pre-release and build options. Note: the [keepachangelog.sh plugin] this will need to be updated to
+ignore versions which only differ in build metadata.
 
 ## [3.0.1] - 2018-07-13
 ### Fixed
@@ -89,8 +92,11 @@ This file uses change log convention from [Keep a CHANGELOG](http://keepachangel
 
 [CHANGELOG.md]: CHANGELOG.md
 [CONTRIBUTING.md]: CONTRIBUTING.md
+[keepachangelog.sh plugin]: plugins/keepachangelog.sh
+[Keep a CHANGELOG]: http://keepachangelog.com
 [LICENCE.md]: LICENCE.md
 [README.md]: README.md
+[Semantic Versioning]: http://semver.org/
 [xdg_basedirs]: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
 
 [unreleased]: https://github.com/markchalloner/git-semver/compare/3.0.1...HEAD

CONTRIBUTING.md

@@ -6,8 +6,14 @@ We accept contributions via Pull Requests on [Github](https://github.com/markcha
 
 ## Contributers
 
+### Users with merges
+
 - https://github.com/markchalloner/git-semver/graphs/contributors
 
+### Others
+
+- [@jaapio](https://github.com/jaapio) ([#26](https://github.com/markchalloner/git-semver/pull/26))
+
 ## Pull Requests
 
 - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

README.md

@@ -52,7 +52,7 @@ The installer will not overwrite any existing [configuration](#configuration) or
 
 ## Usage
 
-### Get latest version tag
+### Get highest version tag
 
 ``` bash
 git semver get
@@ -65,38 +65,61 @@ Will return empty if no version has been created.
 Versions are created as tags and are generated using:
 
 ``` bash
-git semver [major|minor|patch|next]
+git semver [major|minor|patch|next|pre-release|build] [-p <pre-release>] [-b <build>]
 ```
 
-#### Patch (Next)
+#### Major
 
-Increment the patch component (0.1.0 -> 0.1.1)
+Increment the major component (0.1.0 -> 1.0.0), optionally adding a pre-release version and build metadata.
 
 ``` bash
-git semver patch|next
+git semver major [-p <pre-release>] [-b <build>]
 ```
 
-If no version has been created, the initial version will be: **0.1.0**
+If no version has been created, the initial version will be: **1.0.0\[-<pre-release>\]\[+<build>\]**
 
 #### Minor
 
-Increment the minor component (0.1.0 -> 0.2.0)
+Increment the minor component (0.1.0 -> 0.2.0), optionally adding a pre-release version and build metadata.
 
 ``` bash
-git semver minor
+git semver minor [-p <pre-release>] [-b <build>]
 ```
 
-If no version has been created, the initial version will be: **0.1.0**
+If no version has been created, the initial version will be: **0.1.0\[-<pre-release>\]\[+<build>\]**
 
-#### Major
 
-Increment the major component (0.1.0 -> 1.0.0)
+#### Patch (Next)
+
+Increment the patch component (0.1.0 -> 0.1.1), optionally adding a pre-release version and build metadata.
+
+``` bash
+git semver patch|next [-p <pre-release>] [-b <build>]
+```
+
+If no version has been created, the initial version will be: **0.1.0\[-<pre-release>\]\[+<build>\]**
+
+#### Pre-release
+
+Create a new pre-release version based on the next patch version if a release version exists (0.1.0 ->
+0.1.1-<pre-release>) or the current patch version (0.1.0-alpha -> 0.1.0-<pre-release>) if it does not,
+optionally adding build metadata.
+
+``` bash
+git semver pre-release -p <pre-release> [-b <build>]
+```
+
+If no version has been created, the initial version will be: **0.1.0-<pre-release>\[+<build>\]**
+
+#### Build
+
+Create a new build based on the current patch version.
 
 ``` bash
-git semver major
+git semver build -b <build>
 ```
 
-If no version has been created, the initial version will be: **1.0.0**
+If no version has been created, the initial version will be: **0.1.0+<build>**
 
 ### Help