This is a small utility that generates a changelog between two git tags based on GitHub pull request titles as either plaintext or markdown.
An example might look like:
pip install git+https://github.com/cfpb/github-changelog
changelog [-h] [-m] OWNER REPO [PREVIOUS] [CURRENT]
changelog command takes a GitHub repository owner (user or organization), repository name and zero, one, or two tags to limit the set of changes to consider. If no tags are provided, the changelog will be computed between the latest tag and
HEAD. One tag may be provided to set the base tag to compare against
HEAD. Two tags may be provided to specify both base tag and ending tag. The generated changelog will list all GitHub pull requests that have been merged between the specified or inferred tags. If
-m is specified the output will be formatted in markdown and include links to the pull requests.
changelog cfpb github-changelog
Will generate a text changelog between the latest tag and
changelog cfpb github-changelog 1.0.0
Will generate a text changelog between
changelog -m cfpb github-changelog 1.0.0 1.0.1
Will generate a markdown changelog between
Please add issues to the issue tracker.
General instructions on how to contribute can be found in CONTRIBUTING.