# Git Versioning Tool

Semantic versioning management for a project. Inspired by the Semantic Versioning 2.0.0 documentation.

# Installation

Clone the repo and install with make:

~$ git clone git@github.com:bprinty/git-v.git
~$ make install

NOTE: Windows users that do not have Make installed will have to just copy executables to somewhere on their path:

# within git-bash for Windows
~$ git clone git@github.com:bprinty/git-v.git
~$ cd git-v
~$ cp bin/* /usr/local/bin/

# Usage

# Tracking Files

To start tracking specific files for version management with git-v, use:

~$ git v add <file>

Alternatively, just include a .version file in the top-level directory of the repository with names of files to track version information for.

To remove a file from tracking with git-v, use:

~$ git v remove <file>

# Listing Versions

To list version numbers for tracked files, use:

~$ git v list
module/__init__.py ... 1.0.0

# Semantic Versioning

To increment version numbers for all tracked files in a project:

~$ git v up <version-type>

Where <version-type> is either major, minor, or patch. An example of incrementing each of these is below:

~$ git v up patch
module/__init__.py ... 1.0.0 --> 1.0.1

~$ git v up minor
module/__init__.py ... 1.0.0 --> 1.1.0

~$ git v up major
module/__init__.py ... 1.0.0 --> 2.0.0

You can also decrement the versioning with the same type of syntax:

~$ git v down patch
module/__init__.py ... 1.0.1 --> 1.0.0

~$ git v down minor
module/__init__.py ... 1.1.0 --> 1.0.0

~$ git v down major
module/__init__.py ... 2.0.0 --> 1.0.0

# Release Cycle Versioning

To increment the release cycle of the project to the current commit hash, do:

~$ git v rc
module/__init__.py ... 1.0.0 --> 1.0.0-rc7f4f6

Or, to add a specific string as the release cycle tag (i.e. alpha, beta), use:

~$ git v rc alpha
module/__init__.py ... 1.0.0 --> 1.0.0-alpha

To increment/decrement the version of a specified release cycle tag, use:

~$ git v rc beta up
module/__init__.py ... 1.0.0-beta --> 1.0.0-beta.1

~$ git v rc beta up
module/__init__.py ... 1.0.0-beta.1 --> 1.0.0-beta.2

~$ git v rc beta down
module/__init__.py ... 1.0.0-beta.2 --> 1.0.0-beta.1

Note: for any non-rc operation, all text after the - component of the version scheme will be stripped off. To add the release-cycle information back, simply do git v rc again.

# Tagging

To create a tag for your repository with the current tracked version, use:

# normal tag
~$ git v tag
Created tag 0.0.1

# creating a signed tag
~$ git v tag -s
Created tag '0.0.1' (was 0c3f704)

# creating a signed tag with a message
~$ git v tag -s -m "this is a tag"

To delete a tag with the current tracked version, use:

~$ git v tag -d
Deleted tag '0.0.1' (was 0c3f704)

# Questions/Feedback

Submit an issue in the GitHub issue tracker for the project.