/release-note-generator

Primary LanguageShell

Codacy Badge

release-note-generator

Based on Git history (using Angular commit message syntax), this pure shell tool is used to generate a release note in a MarkDown format.

Installation

Put the release-note.sh inside your git repository and give it some executable rights (e.g. sudo chmod +x release-note.sh).

Usage

Help

./release-note.sh -h

Release note between last tag and HEAD

    ./release-note.sh

Release note between two tags

    ./release-note.sh -f <from tag> -t <to tag> #e.g. ./release-note.sh -f 1.0.0 -t 2.0.0

Result example

# Release Note

## From 1.0.0 to 2.0.0

### Bug Fixes
db9b8a82e - fix: this is a commit for fixing a bug 2 (Benjamin Dumont)
369eefa9e - fix: this is a commit for fixing a bug 1 (Benjamin Dumont)

### Features
8a8dbca86 - feat: this is a commit for a feature (Benjamin Dumont)

### Configuration
1428e0136 - chore: generate changelog (Benjamin Dumont)

### Continuous Integration
3bf9378a2 - ci: build configuration (Benjamin Dumont)

List of keywords used to generate the Release Note

  • fix:
  • feat:
  • chore:
  • docs:
  • style:
  • refactor:
  • perf:
  • test:
  • ci:

Limitations

Only works with the angular commit message pattern. Should work with scopes too.