github-changelog-generator/man/git-generate-changelog.md

git-generate-changelog(1) - Generate changelog from github
================================

## SYNOPSIS

`git generate-changelog` [-h|--help] [-u|--user] [-p|--project]

## DESCRIPTION

Automatically generate changelog from your tags, issues, labels and pull requests on GitHub.

## OPTIONS

  -u, --user [USER]

  Username of the owner of target GitHub repo

  -p, --project [PROJECT]

  Name of project on GitHub

  -t, --token [TOKEN]

  To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new

  -f, --date-format [FORMAT]

  Date format. Default is %Y-%m-%d

  -o, --output [NAME]

  Output file. Default is CHANGELOG.md

  -b, --base [NAME]

  Optional base file to append generated changes to.

   --bugs-label [LABEL]

   Setup custom label for bug-fixes section. Default is "**Fixed bugs:**

   --enhancement-label [LABEL]

   Setup custom label for enhancements section. Default is "**Implemented enhancements:**"

   --issues-label [LABEL]

   Setup custom label for closed-issues section. Default is "**Closed issues:**"

   --header-label [LABEL]

   Setup custom header label. Default is "# Changelog"

   --front-matter [JSON]

   Add YAML front matter. Formatted as JSON because it's easier to add on the command line

   --pr-label [LABEL]

   Setup custom label for pull requests section. Default is "**Merged pull requests:**"

   --[no-]issues

   Include closed issues in changelog. Default is true

   --[no-]issues-wo-labels

   Include closed issues without labels in changelog. Default is true

   --[no-]pr-wo-labels

   Include pull requests without labels in changelog. Default is true

   --[no-]pull-requests

   Include pull-requests in changelog. Default is true

   --[no-]filter-by-milestone

   Use milestone to detect when issue was resolved. Default is true

   --[no-]author

   Add author of pull-request in the end. Default is true

   --usernames-as-github-logins

   Use GitHub tags instead of Markdown links for the author of an issue or pull-request.

   --unreleased-only

   Generate log from unreleased closed issues only.

   --[no-]unreleased

   Add to log unreleased closed issues. Default is true

   --unreleased-label [label]

   Setup custom label for unreleased closed issues section. Default is "**Unreleased:**"

   --[no-]compare-link

   Include compare link (Full Changelog) between older version and newer version. Default is true

   --include-labels x,y,z

   Only issues with the specified labels will be included in the changelog.

   --exclude-labels x,y,z

   Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'

   --bug-labels x,y,z

   Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'

   --enhancement-labels x,y,z

   Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'

   --exclude-tags x,y,z

   Changelog will exclude specified tags

   --exclude-tags-regex [REGEX]

   Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*\+\d{1,}"

   --since-tag x

   Changelog will start after specified tag

   --due-tag x

   Changelog will end before specified tag

   --max-issues [NUMBER]

   Max number of issues to fetch from GitHub. Default is unlimited

   --release-url [URL]

   The URL to point to for release links, in printf format (with the tag as variable).

   --github-site [URL]

   The Enterprise Github site on which your project is hosted.

   --github-api [URL]

   The enterprise endpoint to use for your Github API.

   --simple-list

   Create simple list from issues and pull requests. Default is false.

   --future-release [RELEASE-VERSION]

   Put the unreleased changes in the specified release number.

   --release-branch [RELEASE-BRANCH]

   Limit pull requests to the release branch, such as master or release

   --http-cache

   Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.

   --[no-]cache-file [CACHE-FILE]

   Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.

   --cache-log [CACHE-LOG]

   Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.

    --ssl-ca-file [PATH]

   Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.

   --require file1.rb,file2.rb

   Paths to Ruby file(s) to require before generating changelog.

   --[no-]verbose

   Run verbosely. Default is true

   --configure-sections [HASH, STRING]

   Define your own set of sections which overrides all default sections") do |v|

   --add-sections [HASH, STRING]

   Add new sections but keep the default sections"

   -v, --version

   Print version number

   -h, --help

   Displays Help


## EXAMPLES

## AUTHOR

Written by Petr Korolev sky4winder@gmail.com

## REPORTING BUGS

&lt;<https://github.com/skywinder/github-changelog-generator/issues>&gt;

## SEE ALSO

&lt;<https://github.com/skywinder/github-changelog-generator/>&gt;