1
0
Fork 0
mirror of https://github.com/Findus23/new-github-changelog-generator.git synced 2024-06-28 19:30:13 +02:00
Go to file
2019-02-14 14:30:13 +01:00
generator make command required 2019-02-14 14:30:13 +01:00
tests kind of tests 2019-02-14 13:03:32 +01:00
.gitignore first kind of working version 2019-02-02 22:12:08 +01:00
MANIFEST.in add defaultconfig.yaml to package 2019-02-14 14:20:17 +01:00
README.md better cli and README.md 2019-02-14 13:47:07 +01:00
requirements.txt kind of tests 2019-02-14 13:03:32 +01:00
setup.py package data 2019-02-14 14:26:06 +01:00

github-changelog-generator

quickly generate changelogs based on closed github issues and merged PRs since the last release

Install

pip3 install --user https://github.com/Findus23/new-github-changelog-generator/archive/master.zip

(at least until it is published on pypi)

Usage

Run github-changelog-generator init to create an example config file. The GitHub API limits to 60 requests per hour by default, so to use this properly, create a personal access token (you don't need to tick any box) and paste it into the api_token setting in the config file.

Afterwards you can simply create changelogs by specifying the tag or date of the previous release:

 github-changelog-generator generate --since "2019-01-25 00:00:00" --debian-changelog
 
 github-changelog-generator generate --previous-version="3.8.0" --html

You can find more options with --help:

github-changelog-generator --help
github-changelog-generator init --help
github-changelog-generator generate --help