diff --git a/man/git-generate-changelog.1 b/man/git-generate-changelog.1 index bdf7897..a5d4737 100644 --- a/man/git-generate-changelog.1 +++ b/man/git-generate-changelog.1 @@ -1,27 +1,252 @@ -.\" Manpage for git-activity -.TH man 1 "Sep 2015" "1.0" "git genrate-changelog man page" -.SH NAME -git activity \- Generate changelog from github -.SH SYNOPSIS -git generate-changelog [-h|--help] [-u|--user] [-p|--project] -.SH DESCRIPTION -Automatically generate change log from your tags, issues, labels and pull requests on GitHub. -.SH OPTIONS -.TP -.I --h -Show helper provide from gem. -.TP -.I --help -Thos this man page. -.TP -.I -u | --user github_username +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "GIT\-GENERATE\-CHANGELOG" "1" "October 2015" "" "" +. +.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 -.TP -.I -p | --project github_project -Name of project on GitHub Just convenience options to specify user/project: -.SH SEE ALSO -git-for-each-ref(1) -.SH BUGS -No known bugs. -.SH AUTHOR -Petr Korolev +. +.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 +\-\-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 +\-\-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 +Add to log unreleased closed issues\. Default is true +. +.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 +\-\-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 +\-\-[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> diff --git a/man/git-generate-changelog.html b/man/git-generate-changelog.html new file mode 100644 index 0000000..be231c4 --- /dev/null +++ b/man/git-generate-changelog.html @@ -0,0 +1,262 @@ + + + + + + git-generate-changelog(1) - Generate changelog from github + + + + +
+ + + +
    +
  1. git-generate-changelog(1)
    2. +
  2. +
  3. git-generate-changelog(1)
    4. +
+ +

NAME

+

+ git-generate-changelog - Generate changelog from github +

+ +

SYNOPSIS

+ +

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

+ +

DESCRIPTION

+ +

Automatically generate change log 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 "# Change Log"

+ +

--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

+ +

--unreleased-only

+ +

Generate log from unreleased closed issues only.

+ +

--[no-]unreleased

+ +

Add to log unreleased closed issues. Default is true

+ +

--unreleased-label [label]

+ +

Add to log unreleased closed issues. Default is true

+ +

--[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'

+ +

--between-tags x,y,z

+ +

Change log will be filled only between specified tags

+ +

--exclude-tags x,y,z

+ +

Change log will exclude specified tags

+ +

--since-tag x

+ +

Change log will start after specified tag

+ +

--due-tag x

+ +

Change log 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.

+ +

--[no-]verbose

+ +

Run verbosely. Default is true

+ +

-v, --version

+ +

Print version number

+ +

-h, --help

+ +

Displays Help

+ +

EXAMPLES

+ +

AUTHOR

+ +

Written by Petr Korolev sky4winder@gmail.com

+ +

REPORTING BUGS

+ +

<https://github.com/skywinder/github-changelog-generator/issues>

+ +

SEE ALSO

+ +

<https://github.com/skywinder/github-changelog-generator/>

+ + +
    +
  1. +
  2. October 2015
    3. +
  3. git-generate-changelog(1)
    4. +
+ +
+ +