Skip to content

Generate a changelog based on `git log` and GitHub pull requests

License

Notifications You must be signed in to change notification settings

lindydonna/github-pr-changelog

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

github-pr-changelog

Generate a changelog based on git log and GitHub pull requests. It queries GitHub for all pull requests, then uses the git rev-list command to find the hashes for the supplied tag range (with the --from and --to command-line arguments).

Output is either markdown (default), or tab separated values if the flag --tab-output is supplied.

Usage: gh-changelog [options]

GitHub pull request changelog generator

Options:

  -v, --version                    output the version number
  -f, --from <tag>                 start of changelog range, as a git tag or revision
  -t, --to <tag>                   end of changelog range, as a git tag or revision
  -o, --owner <owner>              GitHub owner or organization
  -r, --repo <repo>                GitHub repo
  -d, --git-directory [directory]  directory to a git working tree, or current directory if not specified
  --token [token]                  GitHub access token. If not provided, uses environment variable GITHUB_TOKEN
  --all-prs                        Whether or not to list all pull requests, regardless of the label.
  --tab-output                     If set, will output a table of pull requests
  -h, --help                       output usage information

About

Generate a changelog based on `git log` and GitHub pull requests

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 66.1%
  • TypeScript 33.9%