create_release_notes

Create detailed release notes for a new release of a GitHub repository.

$ create_release_notes -h
usage: create_release_notes [-h] [--head [HEAD]] base milestone token

Create detailed release notes for a new release of a GitHub repository. Run from the root directory of a package.

positional arguments:
base           name of tag to start the range
milestone      name of milestone
token          personal access token (see: https://github.com/settings/tokens)

options:
-h, --help     show this help message and exit
--head [HEAD]  name of tag, branch, SHA to end the range (default="master")

---

Source Code Documentation

Create detailed release notes for a new release of a GitHub repository.

Run from the root directory of a package.

main([base, head, milestone, token, debug])	Command-line application program.
findGitConfigFile([path])	Return full path to ROOT/.git/config file.
getRepositoryInfo([path])	Return (organization, repository) tuple from .git/config file.
get_release_info(token, base_tag_name, ...)	Mine the Github API for information about this release.
parse_command_line()	Command line argument parser.
report(title, repo, milestone, tags, pulls, ...)	Print results to stdout.

murky.create_release_notes.findGitConfigFile(path=None)

Return full path to ROOT/.git/config file.

Supplied ‘path’ must be in the ROOT directory or a subdirectory.

This is a simplistic search that could be improved by using an open source package.

murky.create_release_notes.getRepositoryInfo(path=None)

Return (organization, repository) tuple from .git/config file.

murky.create_release_notes.get_release_info(token, base_tag_name, head_branch_name, milestone_name)

Mine the Github API for information about this release.

murky.create_release_notes.main(base=None, head=None, milestone=None, token=None, debug=False)

Command-line application program.

murky.create_release_notes.parse_command_line()

Command line argument parser.

murky.create_release_notes.report(title, repo, milestone, tags, pulls, issues, commits)

Print results to stdout.