https://github.com/metwork-framework/git_history_to_changelog
yet another tool to generate a changelog from git history (with conventional commit spec)
https://github.com/metwork-framework/git_history_to_changelog
autoreadme github-actions integration-level-3
Last synced: 3 months ago
JSON representation
yet another tool to generate a changelog from git history (with conventional commit spec)
- Host: GitHub
- URL: https://github.com/metwork-framework/git_history_to_changelog
- Owner: metwork-framework
- License: bsd-3-clause
- Created: 2020-12-14T12:44:08.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-15T06:30:23.000Z (about 1 year ago)
- Last Synced: 2026-02-15T17:40:15.229Z (4 months ago)
- Topics: autoreadme, github-actions, integration-level-3
- Language: Python
- Homepage:
- Size: 87.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# git_history_to_changelog
[//]: # (automatically generated from https://github.com/metwork-framework/github_organization_management/blob/master/common_files/README.md)
**Status (master branch)**
[](https://github.com/metwork-framework/git_history_to_changelog/actions?query=workflow%3ACI+branch%3Amaster)
[](https://github.com/metwork-framework/resources/blob/master/badges/maintained.svg)
## What is it?
**GHTC** (**G**it **H**istory **T**o **C**hangelog) is yet another tool to generate a
changelog from git history (with [conventional commit spec](https://www.conventionalcommits.org/)).
## Why another tool?
Just because we didn't find an existing tool matching our needs.
## How to use it?
```console
Usage: ghtc [OPTIONS] REPO_ROOT
Arguments:
REPO_ROOT the fullpath to the git repository [required]
Options:
--tags-regex TEXT regex to select tags to show on changelog
[default: ^v[0-9]]
--starting-rev TEXT starting revision (if not set
ghtc_changelog_start tag if exists, else
first git commit)
--remove-duplicates-entries / --no-remove-duplicates-entries
if True, remove duplicate entries [default:
True]
--unreleased / --no-unreleased if True, add a section about unreleased
changes [default: True]
--include-type TEXT include (only) given conventional types in
changelog (can be used multiple times, all
types by default), available types: other,
build, chore, style, ci, refactor, test,
docs, perf, fix, feat [default: ]
--title TEXT [default: CHANGELOG]
--unreleased-title TEXT [default: [Unreleased]]
--help Show this message and exit.
```
The generated CHANGELOG is sent to standard output.
## Contributing guide
See [CONTRIBUTING.md](CONTRIBUTING.md) file.
## Code of Conduct
See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
## Sponsors
*(If you are officially paid to work on MetWork Framework, please contact us to add your company logo here!)*
[](http://www.meteofrance.com)