SimpleGitVersion

Simple version calculation without additional installers and other dependencies.

Usage

Powershell

$version = Calculate-Version
# 2.1.0

$version = Calculate-Version -autoIncrementLevel minor
# 2.2.0

$version = Calculate-Version -autoIncrementLevel minor -preRelease alpha -preReleaseNumber 2
# 2.2.0-alpha.2

Bash

./SimpleGitVersion.sh
# 2.1.0
./SimpleGitVersion.sh -l minor
# 2.2.0
./SimpleGitVersion.sh -r alpha -n 2 -l minor
# 2.2.0-alpha.2

Benefits

• Simple option to get your last tag.
• Simple pre-release calculation based on last tag.
• No dependencies to install. Only one function to copy in final script.
• Support of custom prefixes [v*], [something-*] of version.
• Support for Bash and Powershell.

Motivation

• Automatic version calculation is very useful for CI/CD processes, when release should be specified for many environment without manual intervention.
• Previously I've used popular tool for calculation, but sometimes it caused problems in use (like too long paths or missing relative branches).
• This project it's a simple solution for simple calcuation of version when advanced possibilies it's not needed.

Compatibility

• Ready to use with GitLab CI/CD.
• Tested on:
  • Windows and Powershell 7,
  • Ubuntu 18.04 and Bash/Powershel 7.

Limitation

• No validation of SemVer. Last tag is recognized as correct version.
• Only one tag per commit.
• No pre-release number calculation. It should be specidied e.g. by build server.

Next steps

• SemVer strict mode.
• More possibilities to define parts of veresion based on SemVer.
• More case studies.
• Possible implementation with other scripting languages.

Contribute

If you want to contribute to a project, your help is very welcome. Please check a page with issues and add new one with your suggestions, then create a fork and start work. When your work will be ready, create a pull request.

Develop

Running Tests

Running the Unit Test Suite

Tests are write with Pester which is a great tool to testing scripts written in PowerShell. Before start work tests, required is installation Pester's module (Pester: Installation Guide);

To run tests on PowerShell console for PowerShell's version run:

Invoke-Pester -Script ./SimpleGitVersion.Tests.ps1

To run tests on PowerShell console for Bash's version run:

Invoke-Pester -Script ./SimpleGitVersion.Tests.ps1

---

Inspired by ❤️ SemVer & GitVersion