https://github.com/findus23/new-github-changelog-generator
https://github.com/findus23/new-github-changelog-generator
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/findus23/new-github-changelog-generator
- Owner: Findus23
- Created: 2019-02-02T21:11:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-14T13:30:29.000Z (over 7 years ago)
- Last Synced: 2025-01-23T22:24:55.786Z (over 1 year ago)
- Language: Python
- Size: 35.2 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# github-changelog-generator
*quickly generate changelogs based on closed github issues and merged PRs since the last release*
## Install
```bash
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*](https://github.com/settings/tokens) (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:
```bash
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`:
```bash
github-changelog-generator --help
github-changelog-generator init --help
github-changelog-generator generate --help
```