Note
This repo is a fork of codacy/git-version with the following features and fixes, all of which have pull-requests back to upstream:
features:
fixes:
These feature and fixes are needed so we can replace the unverified action paulhatch/semantic-version
see https://toitutewhenua.atlassian.net/browse/ENABLE-4773
This repo needs to exist until the above PRs get merged.
To create new release in this fork, run the following scripts:
- install build tool for Crystal language
curl -fsSL https://crystal-lang.org/install.sh | sudo bash - Test and build
make docker_build docker run --entrypoint cat codacy/git-version:$(cat .version) /bin/git-version > bin/git-version
- Commit and push change to master branch
- Create release
gh release create <version> bin/git-version --generate-notes --target <commit-sha>
The goal of this tool is to have a simple versioning system that we can use to track the different releases. The tool prints the current version (e.g. to be used for tagging) depending on the git history and commit messages.
The versioning scheme is assumed to be Semver based.
# .github/workflows/version.yml
name: Git Version
on:
push:
branches:
- master
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }} # checkout the correct branch name
fetch-depth: 0 # fetch the whole repo history
- name: Git Version
id: version
uses: codacy/[email protected]
- name: Use the version
run: |
echo ${{ steps.version.outputs.version }}
- name: Use the previous version
run: |
echo ${{ steps.version.outputs.previous-version }}You can use git-version to version different modules in a mono-repo structure.
This can be achieved by using different prefixes and log-path filters for
different modules.
Assuming the following directory structure, we can use git-version to generate
version with prefix module1-x.x.x for changes in the module1/ directory
and module2-x.x.x for changes in the module2/ directory.
.
├── Dockerfile
├── Makefile
├── README.md
├── module1
│ ├── Dockerfile
│ └── src/
└── module2
├── Dockerfile
└── src/With github actions you can create different workflows that are triggered when changes happen on different directories.
# .github/workflows/module1.yml
name: Version Module 1
on:
pull_request:
paths:
- .github/workflows/module1.yml
- module1/**
push:
paths:
- .github/workflows/module1.yml
- module1/**
branches:
- master
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }} # checkout the correct branch name
fetch-depth: 0 # fetch the whole repo history
- name: Git Version
uses: codacy/[email protected]
with:
prefix: module1-
log-path: module1/# .github/workflows/module2.yml
name: Version Module 2
on:
pull_request:
paths:
- .github/workflows/module2.yml
- module2/**
push:
paths:
- .github/workflows/module2.yml
- module2/**
branches:
- master
jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }} # checkout the correct branch name
fetch-depth: 0 # fetch the whole repo history
- name: Git Version
uses: codacy/[email protected]
with:
prefix: module2-
log-path: module2/Creates a version with the format MAJOR.MINOR.PATCH
To use this you need to be in the working dir of a git project:
$ ./git-version
1.0.0
Versions are incremented since the last tag. The patch version is incremented by default, unless there is at least one commit since the last tag, containing a minor or major identifier (defaults to feature: or breaking:) in the message.
On branches other than the master/main and development branch (default to master and dev) the version is a variation of the latest common tag with the master/main branch, and has the following format:
{MAJOR}.{MINOR}.{PATCH}-{sanitized-branch-name}.{commits-distance}.{hash}
On the development branch the format is the following:
{MAJOR}.{MINOR}.{PATCH}-SNAPSHOT.{hash}
Example:
---A---B---C <= Master (tag: 1.0.1) L <= Master (git-version: 1.0.2)
\ /
D---E---F---G---H---I---J---K <= Foo (git-version: 1.0.2-foo.8.5e30d83)
Example2 (with dev branch):
---A---B---C <= Master (tag: 1.0.1) L <= Master (git-version: 1.0.2)
\ / <= Fast-forward merges to master (same commit id)
C L <= Dev (git-version: 1.0.2-SNAPSHOT.5e30d83)
\ /
E---F---G---H---I---J---K <= Foo (new_version: 1.0.1-foo.7.5e30d83)
Example3 (with breaking message):
---A---B---C <= Master (tag: 1.0.1) L <= Master (git-version: 2.0.0)
\ /
D---E---F---G---H---I---J---K <= Foo (git-version: 2.0.0-foo.8.5e30d83)
\\
message: "breaking: removed api parameter"
You can configure the action with various inputs, a list of which has been provided below:
| Name | Description | Default Value |
|---|---|---|
| tool-version | The version of the tool to run | latest |
| release-branch | The name of the master/main branch | master |
| dev-branch | The name of the development branch | dev |
| skip-prerelease | Skip prerelease part of the version. When true, release-branch and dev-branch are effectively ignored | false |
| minor-identifier | The string used to identify a minor release (wrap with '/' to match using a regular expression) | feature: |
| major-identifier | The string used to identify a major release (wrap with '/' to match using a regular expression) | breaking: |
| prefix | The prefix used for the version name | |
| log-paths | The paths used to calculate changes (comma-separated) |
To use this tool you will need to install a few dependencies:
Ubuntu:
sudo apt-get install \
libevent-dev \
git
Fedora:
sudo dnf -y install \
libevent-devel \
git
Alpine:
apk add --update --no-cache --force-overwrite \
gc-dev pcre-dev libevent-dev \
git
OsX:
brew install \
libevent \
git
Use this image directly on CircleCI for simple steps
version: 2
jobs:
build:
machine: true
working_directory: /app
steps:
- checkout
- run:
name: get new version
command: |
NEW_VERSION=$(docker run --rm -v $(pwd):/repo codacy/git-version)
echo $NEW_VERSION
The pipeline in circleci can deploy this for you when the code is pushed to the remote.
To compile locally you need to install crystal and possibly all required libraries
You can also run everything locally using the makefile.
To get the list of available commands:
$ make help
Great inspiration for this tool has been taken from: GitVersion
Codacy is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
- Identify new Static Analysis issues
- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
- Auto-comments on Commits and Pull Requests
- Integrations with Slack, HipChat, Jira, YouTrack
- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories
Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.
Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.
Codacy is free for Open Source projects.
git-version is available under the Apache 2 license. See the LICENSE file for more info.