Git Tag Version

This is a script to enable simple versioning of git repositories based on tags following the semantic versioning scheme: MAJOR.MINOR.PATCH, eg. 1.0.21. Git tags by default are agnostic to any semantics, see Git-Basics-Tagging. Therefore, this script's only purpose is to ease and enforce proper usage of the semantic versioning scheme.

Only the SCMs meta data is used to store the version information. No change is made to the repository contents if the version changes. If you bump the version, your commit does not change. This may or may not be what you are looking for.

Mind: This script may create new versions by adding git tags as you wolud by using git tag directly, hence it does not push! Remember to use git push --tags to make your locally created tags available at your remote repository.

Use Cases

New version by continuous integration

1. Change your repository, commit and push.
2. Your CI is triggered due to the push and checks the repository.
3. Your CI tests and checks all pass, thus you would like to assign this particular commit a new patch version number.
4. The CI uses tags to assign a new version number without changing the repository - no new commit is generated.

Manually assigning a new version

1. After weeks of hard work you are done with the basic implementation of your most precious application.
2. To celebrate you want to assign a 1.0.0 version to your latest commit.
3. You simply call the gtv script creating a 'v1.0.0' tag.
4. By pushing to your remote repository your v1.0.0. application is made public.

Basic Usage

Refer to the online help by calling gtv help on the command line for a complete list of supported commands.

# initialize by creating a 0.0.0 version
gtv init
# show current version, eg. 1.21.3
gtv show
# create a new tag with an increased minor version
gtv new minor
# show current version, eg. 1.22.0
gtv show
# assign an arbitrary but strictly increasing version number
gtv set 1.22.1
# 'show current version' is the default command, eg. 1.22.1
gtv
# create a new tag with an increased major version and message
gtv new major -m "new version description message"
# shows tag v2.0.0 with message "NEW"
git show $(git describe)
# create a new tag with an increased major version, message and suffix
gtv new major --message=ALPHA --suffix=alpha
# shows tag v3.0.0-alpha with message "ALPHA"
git show $(git describe)
# ERROR!!! Not a strictly increaing number
gtv set 1.0.0

Installation

For the impatient:

# install or update gtv
curl -sL https://github.com/raw/jola5/gtv/master/install.sh | sudo bash -

Since gtv is a plain shell script you can literally put it wherever you want and execute it as you would any other script. But putting gtv with the right name in the right place simplifies usage a lot. The script installs gtv in /usr/local/bin thus giving you these advantages:

1. Gtv is available for all users on your machine
2. You can access gtv by calling gtv directly or via the git alias git tag-version

If you want to install gtv in a separate folder you can do so by calling the installation script like this:

# install or update in a alternative directory
curl -sL https://github.com/raw/jola5/gtv/master/install.sh | sudo bash /dev/stdin "path/to/my/custom/installation"

Mind, you may be unable to properly call gtv and the git tag-version alias if your custom folder is not in your search path.

Updating

You can update gtv by simply calling the installation script again. If there is a newer version your installation is updated. This does not change your configuration settings in any way.

Configuration

We utilize the git configuration capabilities themselves for our gtv configuration. So pay attention if you use this setting on your local or gobal git config. Here is a example, for details keep reading.

[gtv]
strict-mode = true
suffix-delimiter = +

For general usage information on the git configuration see git help config.

strict-mode

Assigning mulitple version tags to the same commit is possible by default, if you want to omit this behaviour use the strict-mode option. You can enable this strict-mode at all times by utilizing your git configuration like this git config gtv.strict-mode true. You can temporarily disable strict-mode again by using the non-strict option. The appropriate git configuration value is nothing or git config gtv.strict-mode anything-but-true.

Do not use the strict and non-strict options at the same time, because this leads to undefined behaviour.

suffix-delimiter

You can change the suffix delimiter that is v1.1.1<SUFFIX-DELIMITER><SUFFIX> only by using the configuration option. Mind, the appropriate values are restricted by the git tag command since a tag needs to follow the reference name rule. Refer to git check-ref-format for details.

Development

Build

Since gtv is a plain shell script there is no original build step. Except we are including the version number within the released gtv artifact.

Create a gtv release artifact with this neat recursive solution:

make.sh build $(git-tag-version)

For official releases, however, we create a new version tag of the current release commit - with gtv obviously - and push to github. Travis automically builds, tests and verifies this release. If the build is successful, Travis creates the official release artifact on github. Then we can add our release notes manually.

Format, Validate and Test

Shfmt is used to format our source code. You should use this before committing your changes to guarantee a consistent source code formatting:

make.sh format

We use shellcheck for static analysis, and travis lint to check the .travis.yml file. Findings of the static analyzer do not fail our build, for exactly this reason we need pay special attention to any messages:

make.sh validate

Finally we perform our BATS supported tests with:

make.sh test
# you can execute specific test targets like this
make.sh test '05*'