1
0
Fork 0
mirror of https://github.com/Luzifer/git-changerelease.git synced 2024-10-18 14:14:20 +00:00
git-changerelease/README.md

39 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2016-07-14 12:33:40 +00:00
![license](https://badges.fyi/github/license/Luzifer/git-changerelease)
[![download](https://badges.fyi/static/download/on GoBuilder.me)](https://gobuilder.me/github.com/Luzifer/git-changerelease)
![travis](https://badges.fyi/travis/Luzifer/git-changerelease)
2016-07-14 12:03:25 +00:00
# Luzifer / git-changerelease
`git-changerelease` is a git-subcommand to write the changelog in a consistent format and tag it using [semantic versioning](http://semver.org/). You can see the version it writes in the [History.md](History.md) file in this repository.
## Features
- Specify regular expressions to match the commit subject against for automated detection of major / minor / patch releases
- Automatically write Changelog from commits
- Start editor to change the Changelog (and the version) before tagging
## Usage
- Generate a configuration file using `git changerelease --create-config`
- Edit your matchers in the configuration file just created
- Commit and release:
```bash
# git init
Initialized empty Git repository in /tmp/test/.git/
# git commit --allow-empty -m 'add an empty commit'
[master (root-commit) 0cc02e6] add an empty commit
# git-changerelease
# git describe --tags HEAD
v0.1.0
# git commit --allow-empty -m 'fix another empty commit'
[master 69d6f0e] fix another empty commit
# git-changerelease
# git describe --tags HEAD
v0.1.1
```