loghub 0.1.2

Generate changelogs based on Github milestones or tags

Build status

Project information

Description

Changelog generator based on milestone or tags for github.

Installation

Using pip

pip install loghub

Using conda

conda install loghub -c conda-forge

Usage

loghub can be used to generate changelog based on milestones or on tags.

In projects where milestones are used to track a release we can use for example:

loghub spyder-ide/spyder -m v3.0

In projects where milestones are used to track chunks of work but not releases, we can use tags to get the changes after the latest release, for example:

loghub spyder-ide/spyder -st v3.0.0b7

Or if loghub is used to generate old changelogs (or update changelogs), we can also use tags to limit the range , for example:

loghub spyder-ide/spyder -st v3.0.0b7 -ut v3.0.0

For private repos, just add the username and password arguments, for example:

loghub spyder-ide/spyder -st v3.0.0b7 -ut v3.0.0 -u <username> -p <password>

Detailed CLI arguments

usage: loghub [-h] [-m MILESTONE] [-st SINCE_TAG] [-ut UNTIL_TAG]
              [-f OUTPUT_FORMAT] [-u USER] [-p PASSWORD]
              repository

Script to print the list of issues and pull requests closed in a given
milestone

positional arguments:
  repository            Repository name to generate the Changelog for, in the
                        form user/repo or org/repo (e.g. spyder-ide/spyder)

optional arguments:
  -h, --help
                        Show this help message and exit

  -m MILESTONE, --milestone MILESTONE
                        Github milestone to get issues and pull requests for

  -st SINCE_TAG, --since-tag SINCE_TAG
                        Github issues and pull requests since tag

  -ut UNTIL_TAG, --until-tag UNTIL_TAG
                        Github issues and pull requests until tag

  -f OUTPUT_FORMAT, --format OUTPUT_FORMAT
                        Format for print, either 'changelog' (for Changelog.md
                        file) or 'release' (for the Github Releases page).
                        Default is 'changelog'. The 'release' option doesn't
                        generate Markdown hyperlinks.

  -u USER, --user USER
                        Github user name

  -p PASSWORD, --password PASSWORD
                        Github user password