8d74965019
* OctoFetcher: http_cache options conditional * Locate cache directory using Dir.tmpdir * Cache files options can not have defaults
295 lines
5.2 KiB
Groff
295 lines
5.2 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "GIT\-GENERATE\-CHANGELOG" "1" "December 2016" "" ""
|
|
.
|
|
.SH "NAME"
|
|
\fBgit\-generate\-changelog\fR \- Generate changelog from github
|
|
.
|
|
.SH "SYNOPSIS"
|
|
\fBgit generate\-changelog\fR [\-h|\-\-help] [\-u|\-\-user] [\-p|\-\-project]
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Automatically generate change log from your tags, issues, labels and pull requests on GitHub\.
|
|
.
|
|
.SH "OPTIONS"
|
|
\-u, \-\-user [USER]
|
|
.
|
|
.P
|
|
Username of the owner of target GitHub repo
|
|
.
|
|
.P
|
|
\-p, \-\-project [PROJECT]
|
|
.
|
|
.P
|
|
Name of project on GitHub
|
|
.
|
|
.P
|
|
\-t, \-\-token [TOKEN]
|
|
.
|
|
.P
|
|
To make more than 50 requests per hour your GitHub token is required\. You can generate it at: https://github\.com/settings/tokens/new
|
|
.
|
|
.P
|
|
\-f, \-\-date\-format [FORMAT]
|
|
.
|
|
.P
|
|
Date format\. Default is %Y\-%m\-%d
|
|
.
|
|
.P
|
|
\-o, \-\-output [NAME]
|
|
.
|
|
.P
|
|
Output file\. Default is CHANGELOG\.md
|
|
.
|
|
.P
|
|
\-b, \-\-base [NAME]
|
|
.
|
|
.P
|
|
Optional base file to append generated changes to\.
|
|
.
|
|
.P
|
|
\-\-bugs\-label [LABEL]
|
|
.
|
|
.P
|
|
Setup custom label for bug\-fixes section\. Default is "\fBFixed bugs:\fR
|
|
.
|
|
.P
|
|
\-\-enhancement\-label [LABEL]
|
|
.
|
|
.P
|
|
Setup custom label for enhancements section\. Default is "\fBImplemented enhancements:\fR"
|
|
.
|
|
.P
|
|
\-\-issues\-label [LABEL]
|
|
.
|
|
.P
|
|
Setup custom label for closed\-issues section\. Default is "\fBClosed issues:\fR"
|
|
.
|
|
.P
|
|
\-\-header\-label [LABEL]
|
|
.
|
|
.P
|
|
Setup custom header label\. Default is "# Change Log"
|
|
.
|
|
.P
|
|
\-\-front\-matter [JSON]
|
|
.
|
|
.P
|
|
Add YAML front matter\. Formatted as JSON because it\'s easier to add on the command line
|
|
.
|
|
.P
|
|
\-\-pr\-label [LABEL]
|
|
.
|
|
.P
|
|
Setup custom label for pull requests section\. Default is "\fBMerged pull requests:\fR"
|
|
.
|
|
.P
|
|
\-\-[no\-]issues
|
|
.
|
|
.P
|
|
Include closed issues in changelog\. Default is true
|
|
.
|
|
.P
|
|
\-\-[no\-]issues\-wo\-labels
|
|
.
|
|
.P
|
|
Include closed issues without labels in changelog\. Default is true
|
|
.
|
|
.P
|
|
\-\-[no\-]pr\-wo\-labels
|
|
.
|
|
.P
|
|
Include pull requests without labels in changelog\. Default is true
|
|
.
|
|
.P
|
|
\-\-[no\-]pull\-requests
|
|
.
|
|
.P
|
|
Include pull\-requests in changelog\. Default is true
|
|
.
|
|
.P
|
|
\-\-[no\-]filter\-by\-milestone
|
|
.
|
|
.P
|
|
Use milestone to detect when issue was resolved\. Default is true
|
|
.
|
|
.P
|
|
\-\-[no\-]author
|
|
.
|
|
.P
|
|
Add author of pull\-request in the end\. Default is true
|
|
.
|
|
.P
|
|
\-\-usernames\-as\-github\-logins
|
|
.
|
|
.P
|
|
Use GitHub tags instead of Markdown links for the author of an issue or pull\-request\.
|
|
.
|
|
.P
|
|
\-\-unreleased\-only
|
|
.
|
|
.P
|
|
Generate log from unreleased closed issues only\.
|
|
.
|
|
.P
|
|
\-\-[no\-]unreleased
|
|
.
|
|
.P
|
|
Add to log unreleased closed issues\. Default is true
|
|
.
|
|
.P
|
|
\-\-unreleased\-label [label]
|
|
.
|
|
.P
|
|
Setup custom label for unreleased closed issues section\. Default is "\fBUnreleased:\fR"
|
|
.
|
|
.P
|
|
\-\-[no\-]compare\-link
|
|
.
|
|
.P
|
|
Include compare link (Full Changelog) between older version and newer version\. Default is true
|
|
.
|
|
.P
|
|
\-\-include\-labels x,y,z
|
|
.
|
|
.P
|
|
Only issues with the specified labels will be included in the changelog\.
|
|
.
|
|
.P
|
|
\-\-exclude\-labels x,y,z
|
|
.
|
|
.P
|
|
Issues with the specified labels will be always excluded from changelog\. Default is \'duplicate,question,invalid,wontfix\'
|
|
.
|
|
.P
|
|
\-\-bug\-labels x,y,z
|
|
.
|
|
.P
|
|
Issues with the specified labels will be always added to "Fixed bugs" section\. Default is \'bug,Bug\'
|
|
.
|
|
.P
|
|
\-\-enhancement\-labels x,y,z
|
|
.
|
|
.P
|
|
Issues with the specified labels will be always added to "Implemented enhancements" section\. Default is \'enhancement,Enhancement\'
|
|
.
|
|
.P
|
|
\-\-between\-tags x,y,z
|
|
.
|
|
.P
|
|
Change log will be filled only between specified tags
|
|
.
|
|
.P
|
|
\-\-exclude\-tags x,y,z
|
|
.
|
|
.P
|
|
Change log will exclude specified tags
|
|
.
|
|
.P
|
|
\-\-exclude\-tags\-regex [REGEX]
|
|
.
|
|
.P
|
|
Apply a regular expression on tag names so that they can be excluded, for example: \-\-exclude\-tags\-regex "\.*+\ed{1,}"
|
|
.
|
|
.P
|
|
\-\-since\-tag x
|
|
.
|
|
.P
|
|
Change log will start after specified tag
|
|
.
|
|
.P
|
|
\-\-due\-tag x
|
|
.
|
|
.P
|
|
Change log will end before specified tag
|
|
.
|
|
.P
|
|
\-\-max\-issues [NUMBER]
|
|
.
|
|
.P
|
|
Max number of issues to fetch from GitHub\. Default is unlimited
|
|
.
|
|
.P
|
|
\-\-release\-url [URL]
|
|
.
|
|
.P
|
|
The URL to point to for release links, in printf format (with the tag as variable)\.
|
|
.
|
|
.P
|
|
\-\-github\-site [URL]
|
|
.
|
|
.P
|
|
The Enterprise Github site on which your project is hosted\.
|
|
.
|
|
.P
|
|
\-\-github\-api [URL]
|
|
.
|
|
.P
|
|
The enterprise endpoint to use for your Github API\.
|
|
.
|
|
.P
|
|
\-\-simple\-list
|
|
.
|
|
.P
|
|
Create simple list from issues and pull requests\. Default is false\.
|
|
.
|
|
.P
|
|
\-\-future\-release [RELEASE\-VERSION]
|
|
.
|
|
.P
|
|
Put the unreleased changes in the specified release number\.
|
|
.
|
|
.P
|
|
\-\-release\-branch [RELEASE\-BRANCH]
|
|
.
|
|
.P
|
|
Limit pull requests to the release branch, such as master or release
|
|
.
|
|
.P
|
|
\-\-http\-cache
|
|
.
|
|
.P
|
|
Use HTTP Cache to cache Github API requests (useful for large repos) Default is true\.
|
|
.
|
|
.P
|
|
\-\-[no\-]cache\-file [CACHE\-FILE]
|
|
.
|
|
.P
|
|
Filename to use for cache\. Default is github\-changelog\-http\-cache in a temporary directory\.
|
|
.
|
|
.P
|
|
\-\-cache\-log [CACHE\-LOG]
|
|
.
|
|
.P
|
|
Filename to use for cache log\. Default is github\-changelog\-logger\.log in a temporary directory\.
|
|
.
|
|
.P
|
|
\-\-[no\-]verbose
|
|
.
|
|
.P
|
|
Run verbosely\. Default is true
|
|
.
|
|
.P
|
|
\-v, \-\-version
|
|
.
|
|
.P
|
|
Print version number
|
|
.
|
|
.P
|
|
\-h, \-\-help
|
|
.
|
|
.P
|
|
Displays Help
|
|
.
|
|
.SH "EXAMPLES"
|
|
.
|
|
.SH "AUTHOR"
|
|
Written by Petr Korolev sky4winder@gmail\.com
|
|
.
|
|
.SH "REPORTING BUGS"
|
|
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/issues\fR>
|
|
.
|
|
.SH "SEE ALSO"
|
|
<\fIhttps://github\.com/skywinder/github\-changelog\-generator/\fR>
|