git-mkver

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 57 Open GitHub ↗

Automatic Semantic Versioning for git based software development

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#  git-mkver

Automatic Semantic Versioning for git based software development.

For more information head to the [project site](https://idc101.github.io/git-mkver/).

## Features

- Determine next version based on:
    - Last tagged commit
    - [Conventional Commits](https://www.conventionalcommits.org/)
    - Branch names
    - Manual tagging
- Next version conforms to [Semantic Versioning](https://semver.org/) scheme
- Patch the next version into source files using a configurable find and replace system
- Tag the current commit with the next version number

Works out of the box with trunk based development, GitFlow and GithubFlow. Alternatively all of this can be configured
based on the branch name so release/main branches get different version numbers to develop or feature branches.

## Installation

[Install](https://idc101.github.io/git-mkver/installation) with brew, scoop or simply download the binary for your os
from the [releases](https://github.com/idc101/git-mkver/releases) page and copy somewhere on your path.

## Usage

Start by using [Conventional Commits](https://www.conventionalcommits.org/) to indicate whether the commits contain
major, minor or patch level changes.

```bash
$ git commit -m "feat: added a new feature (this will increment the minor version)"
```

Then call `git mkver next` and it will tell you the next version of the software should be if you publish now.

```bash
$ git mkver next
v0.4.0
```

### Tagging

If you would like to publish a version, git-mkver can tag the current commit.

```bash
$ git mkver tag
```

This will apply an annotated tag from the `next` command to the current commit.

### Patching versions in files

If you would like to patch version numbers in files prior to building and tagging then
you can use the `patch` command. The files to be patched and the replacements are
defined in the `mkver.conf` config file. A large number of standard patches come
pre-defined.

```bash
$ git mkver patch
```

git-mkver

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README