https://github.com/luzifer/git-changerelease

git-subcommand to write the changelog in a consistent format and tag it using semantic versioning
https://github.com/luzifer/git-changerelease

changelog git git-subcommand semver

Last synced: about 1 month ago
JSON representation

git-subcommand to write the changelog in a consistent format and tag it using semantic versioning

• Host: GitHub
• URL: https://github.com/luzifer/git-changerelease
• Owner: Luzifer
• License: apache-2.0
• Created: 2016-07-14T11:50:30.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-29T11:37:09.000Z (about 1 year ago)
• Last Synced: 2024-10-13T02:40:52.034Z (3 months ago)
• Topics: changelog, git, git-subcommand, semver
• Language: Shell
• Homepage:
• Size: 1.02 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Go Report Card](https://goreportcard.com/badge/github.com/Luzifer/git-changerelease)](https://goreportcard.com/report/github.com/Luzifer/git-changerelease)

![](https://badges.fyi/github/license/Luzifer/git-changerelease)

![](https://badges.fyi/github/downloads/Luzifer/git-changerelease)

![](https://badges.fyi/github/latest-release/Luzifer/git-changerelease)

![](https://knut.in/project-status/git-changerelease)

# 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

```