https://github.com/jackgerrits/git-changelog-generator
Git repository changelog generator
https://github.com/jackgerrits/git-changelog-generator
Last synced: 2 months ago
JSON representation
Git repository changelog generator
- Host: GitHub
- URL: https://github.com/jackgerrits/git-changelog-generator
- Owner: jackgerrits
- License: mit
- Created: 2020-07-31T01:58:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-10T20:54:07.000Z (over 1 year ago)
- Last Synced: 2025-01-23T06:32:34.163Z (4 months ago)
- Language: Python
- Size: 12.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Changelog Generator
Easily generate a changelog for a git repository by filling in a template file.
```
usage: git-changelog-generator.py [-h] --file FILE --range RANGE --dir DIR
[--additional_data ADDITIONAL_DATA]
Extract commits from a git repo and format according to template
optional arguments:
-h, --help show this help message and exit
--file FILE, -f FILE Template file to process
--range RANGE, -r RANGE
git log range to extract commits for
--dir DIR, -d DIR directory of repo to read commits from
--additional_data ADDITIONAL_DATA, -c ADDITIONAL_DATA
Additional data values pass to template, must be in the form key=value
```
Note: The program assumes the current working directory is the in the git repository to generate the changelog for.
`-r` is a passed to the git log command directly. You use things such as:
- A commit range - `HEAD~4..HEAD` or `1.1.0..2.0.0`
- A number of commits `-n 4`
## Templating
The Python implementation, [Chevron](https://github.com/noahmorrison/chevron), of the [{{ Mustache }}](https://mustache.github.io/) template specification is used.
The input file is processed and according to the Mustache syntax. The values available in the template are a list of commits that are extracted from the git log as well as additional data that can be provided on the command line.
A `commit` contains the following fields:
- `subject` - Subject line of commit
- `commit` - Full commit hash
- `author_name` - Author name
- `author_email` - Author email
- `body` - Full body of commit
- `type` - Semantic PR type of commit
- `breaking` - If this is a breaking change, boolean
- `pr_num` - Extracted from commits where the subject contiains `(#XXXX)`
An `author` contains the following fields:
- `name` - Author name
- `email` - Author email
Data passed to template is as follows:
- `commits` - list, each item of type `commit`
- `authors` - list, each item of type `author`
- `unknown_type_commits` - list, each time of type `commit`, where `type` field == `unknown`
- `feat_type_commits` - list, each time of type `commit`, where `type` field == `feat`
- `fix_type_commits` - list, each time of type `commit`, where `type` field == `fix`
- `docs_type_commits` - list, each time of type `commit`, where `type` field == `docs`
- `style_type_commits` - list, each time of type `commit`, where `type` field == `style`
- `refactor_type_commits` - list, each time of type `commit`, where `type` field == `refactor`
- `perf_type_commits` - list, each time of type `commit`, where `type` field == `perf`
- `test_type_commits` - list, each time of type `commit`, where `type` field == `test`
- `build_type_commits` - list, each time of type `commit`, where `type` field == `build`
- `ci_type_commits` - list, each time of type `commit`, where `type` field == `ci`
- `chore_type_commits` - list, each time of type `commit`, where `type` field == `chore`
- `revert_type_commits` - list, each time of type `commit`, where `type` field == `revert`
Additional data can be provided as command line arguments to do things like specify a release version in the template. The `-c` argument must be passed as a `key=value` pair. For values to have spaces then just surround the entire argument in quotes `-c "key=value"`.
If the data does not exist then the templating engine will simply ignore the value.
## Example
Given the following template file:
```
# Changelist
Version: {{version}}
{{#commits}}
- {{commit}} {{author_name}}
- {{subject}}
{{/commits}}
```
Running the following command:
```sh
python git-changelog-generator.py -f example-changelog.template.md -r "HEAD~10..HEAD" -c version=2.0
```
May produce output similar to:
```
# Changelist
Version: 2.0
- 3fc607e5cbb2cfa613b67cabf60372e726575cd6 Jack Gerrits
- Refactor input and basic window handling into a window object
- 8e0fbb36329985672cb5260320836b55b9a71310 Jack Gerrits
- various small const and constexpr related things
- 2cc48e7f7e0d850d5dec9a3aa4756167b35268a5 Jack Gerrits
- Add CLion things to gitignore
- 84042db1612dfbffe4fda7f9625ff60005d3511c Jack Gerrits
- Add glm_ext header to deal with unknown pragma warning
- 0e3928524e8297b4f485fc48b484765d2d741b40 Jack Gerrits
- Fix build on Ubuntu
- cf74b2fa96501d5d2aea9403fcff34030abb2876 Jack Gerrits
- Applying clang-tidy fixes
- 785b85bf69ba72d72d88286fe632003c9904512c Jack Gerrits
- Set CMake policy CMP0092 to new to avoid warnings with MSVC
- e7043c5bdac810ce906e7b13ee9d9b07eb68ed6b Jack Gerrits
- Run format over code
- f125be755f1bbd9354a4292bc840f679d853c930 Jack Gerrits
- Bring in fmt
- f2b740becfa982ef4e999f44842ba97996e12e38 Jack Gerrits
- Remove shader from target sources
```