chglog

git-chglog

CHANGELOG generator implemented in Go (Golang).
Anytime, anywhere, Write your CHANGELOG.

Table of Contents

• Features
• How it works
• Getting Started
  • Installation
    • Homebrew (for macOS users)
    • Go users
  • Test Installation
  • Quick Start
• CLI Usage
  • tag query
• Configuration
• Templates
• Supported Styles
• FAQ
• TODO
• Thanks
• Contributing
  • Development
  • Feedback
• CHANGELOG
• Related Projects
• License

Features

• ♻ High portability
  • It works with single binary. Therefore, any project (environment) can be used.
• 🔰 Simple usability
  • The CLI usage is very simple and has low learning costs.
  • For example, the simplest command is $ git-chglog.
• 🚀 High flexibility
  • Commit message format and ...
  • CHANGELOG's style (Template) and ...
  • etc ...

How it works

git-chglog internally uses the git command to get data to include in CHANGELOG.
The basic steps are as follows.

1. Get all the tags.
2. Get the commit contained between tagA and tagB.
3. Execute with all tags corresponding to tag query that specified Step 1 to 2.

Getting Started

We will start with installation and introduce the steps up to the automatic generation of the configuration file and template.

Installation

Please install git-chglog in a way that matches your environment.

Homebrew (for macOS users)

$ brew tap git-chglog/git-chglog
$ brew install git-chglog

Scoop (for Windows users)

$ scoop install git-chglog

Go users

$ go get -u github.com/macroprog/git-chglog/cmd/git-chglog

If you are in another platform, you can download binary from release page and place it in $PATH directory.

Test Installation

You can check with the following command whether the git-chglog command was included in a valid $PATH.

$ git-chglog --version
# output the git-chglog version

Quick Start

git-chglog requires configuration files and templates to generate CHANGELOG.
However, it is a waste of time to create configuration files and templates with scratch.

Therefore we recommend using the --init option which can create them interactively 👍

$ git-chglog --init

You are now ready for configuration files and templates!

Let's immediately generate CHANGELOG of your project.
By doing the following simple command, Markdown of CHANGELOG is displayed on stdout.

$ git-chglog

Use -o (--output) option if you want to output to file instead of stdout.

$ git-chglog -o CHANGELOG.md

This is how basic usage is over!
In order to make better CHANGELOG, please refer to the following document and customize it.

CLI Usage

$ git-chglog --help

USAGE:
  git-chglog [options] <tag query>

    There are the following specification methods for <tag query>.

    1. <old>..<new> - Commit contained in <old> tags from <new>.
    2. <name>..     - Commit from the <name> to the latest tag.
    3. ..<name>     - Commit from the oldest tag to <name>.
    4. <name>       - Commit contained in <name>.

OPTIONS:
  --init                                generate the git-chglog configuration file in interactive
  --config value, -c value              specifies a different configuration file to pick up (default: ".chglog/config.yml")
  --output value, -o value              output path and filename for the changelogs. If not specified, output to stdout
  --next-tag value                      treat unreleased commits as specified tags (EXPERIMENTAL)
  --silent                              disable stdout output
  --no-color                            disable color output [$NO_COLOR]
  --no-emoji                            disable emoji output [$NO_EMOJI]
  --tag-filter-pattern value, -p value  regular expression of tag filter. Is specified, only matched tags will be picked
  --help, -h                            show help
  --version, -v                         print the version

EXAMPLE:

  $ git-chglog

    If <tag query> is not specified, it corresponds to all tags.
    This is the simplest example.

  $ git-chglog 1.0.0..2.0.0

    The above is a command to generate CHANGELOG including commit of 1.0.0 to 2.0.0.

  $ git-chglog 1.0.0

    The above is a command to generate CHANGELOG including commit of only 1.0.0.

  $ git-chglog $(git describe --tags $(git rev-list --tags --max-count=1))

    The above is a command to generate CHANGELOG with the commit included in the latest tag.

  $ git-chglog --output CHANGELOG.md

    The above is a command to output to CHANGELOG.md instead of standard output.

  $ git-chglog --config custom/dir/config.yml

    The above is a command that uses a configuration file placed other than ".chglog/config.yml".

tag query

You can specify a commit to include in the generation of CHANGELOG using <tag query>.
The table below shows Query patterns and summaries, and Query examples.

Configuration

The git-chglog configuration is write with the yaml file. Default location is .chglog/config.yml.

Below is a complete list that you can use with git-chglog.

bin: git
style: ""
template: CHANGELOG.tpl.md
info:
  title: CHANGELOG
  repository_url: https://github.com/macroprog/git-chglog

options:
  commits:
    filters:
      Type:
        - feat
    sort_by: Scope

  commit_groups:
    group_by: Type
    sort_by: Title
    title_maps:
      feat: Features

  header:
    pattern: "<regexp>"
    pattern_maps:
      - PropName

  issues:
    prefix:
      - #

  refs:
    actions:
      - Closes
      - Fixes

  merges:
    pattern: "^Merge branch '(\\w+)'$"
    pattern_maps:
      - Source

  reverts:
    pattern: "^Revert \"([\\s\\S]*)\"$"
    pattern_maps:
      - Header

  notes:
    keywords:
      - BREAKING CHANGE

bin

Git execution command.

style

CHANGELOG style. Automatic linking of issues and notices, initial value setting such as merges etc. are done automatically.

template

Path for template file. It is specified by a relative path from the setting file. Absolute pass is ok.

info

Metadata for CHANGELOG. Depending on Style, it is sometimes used in processing, so it is recommended to specify it.

options

Options used to process commits.

options.commits

Option concerning acquisition and sort of commit.

options.commit_groups

Option for groups of commits.

options.header

This option is used for parsing the commit header.

options.issues

This option is used to detect issues.

options.refs

This option is for parsing references.

options.merges

Option to detect and parse merge commit.

options.reverts

Option to detect and parse revert commit.

options.notes

Option to detect notes contained in commit body.

Templates

The git-chglog template uses the text/template package. For basic usage please refer to the following.

text/template

If you are not satisfied with the prepared template please try customizing.

The basic templates are as follows.

Example:

{{ if .Versions -}}
<a name="unreleased"></a>
## [Unreleased]

{{ if .Unreleased.CommitGroups -}}
{{ range .Unreleased.CommitGroups -}}
### {{ .Title }}
{{ range .Commits -}}
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}

{{ range .Versions }}
<a name="{{ .Tag.Name }}"></a>
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
{{ range .CommitGroups -}}
### {{ .Title }}
{{ range .Commits -}}
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
{{ end }}
{{ end -}}

{{- if .RevertCommits -}}
### Reverts
{{ range .RevertCommits -}}
- {{ .Revert.Header }}
{{ end }}
{{ end -}}

{{- if .MergeCommits -}}
### Pull Requests
{{ range .MergeCommits -}}
- {{ .Header }}
{{ end }}
{{ end -}}

{{- if .NoteGroups -}}
{{ range .NoteGroups -}}
### {{ .Title }}
{{ range .Notes }}
{{ .Body }}
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}

{{- if .Versions }}
[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
{{ range .Versions -}}
{{ if .Tag.Previous -}}
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
{{ end -}}
{{ end -}}
{{ end -}}

See godoc RenderData for available variables.

Supported Styles

📝 Even with styles that are not yet supported, it is possible to make ordinary CHANGELOG.

FAQ

$ git-chglog --next-tag 2.0.0 -o CHANGELOG.md
$ git commit -am "release 2.0.0"
$ git tag 2.0.0

$ git-chglog --tag-filter-pattern '^v'

TODO

• Windows Support
• More styles (GitHub, GitLab, Bitbucket 🎉)
• Snippetization of configuration files (improvement of reusability)
• More test test test ... (and example)

Thanks

git-chglog is inspired by conventional-changelog. Thank you!

Contributing

We are always welcoming your contribution 👏

Development

1. Fork (https://github.com/macroprog/git-chglog) 🎉
2. Create a feature branch ☕
3. Run test suite with the $ make test command and confirm that it passes ⚡
4. Commit your changes 📝
5. Rebase your local changes against the master branch 💡
6. Create new Pull Request 💌

Bugs, feature requests and comments are more than welcome in the issues.

Feedback

I would like to make git-chglog a better tool.
The goal is to be able to use in various projects.

Therefore, your feedback is very useful.
I am very happy to tell you your opinions on Issues and PR ❤

CHANGELOG

See CHANGELOG.md

Related Projects

• git-chglog/artwork - Assets for git-chglog.

License

MIT © tsuyoshiwada