From e829be38bdb0b7da26e0bc355b315661900947f4 Mon Sep 17 00:00:00 2001 From: Alejandro Mataloni Date: Tue, 12 May 2015 11:49:59 -0300 Subject: [PATCH] update readme and rubocop fix. --- .rubocop_todo.yml | 4 ++-- README.md | 45 +++++++++++++++++++++++---------------------- 2 files changed, 25 insertions(+), 24 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 9bd544a..427a067 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -7,7 +7,7 @@ # Offense count: 21 Metrics/AbcSize: - Max: 71 + Enabled: false # Offense count: 2 Metrics/BlockNesting: @@ -25,7 +25,7 @@ Metrics/CyclomaticComplexity: # Offense count: 28 # Configuration parameters: CountComments. Metrics/MethodLength: - Max: 118 + Enabled: false # Offense count: 5 Metrics/PerceivedComplexity: diff --git a/README.md b/README.md index c63d616..bc2aefc 100644 --- a/README.md +++ b/README.md @@ -83,28 +83,29 @@ As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* chan Type `github_changelog_generator --help` for detailed usage. Usage: changelog_generator [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 required. You can generate it here: https://github.com/settings/tokens/new - -f, --date-format [FORMAT] Date format. Default is %d/%m/%y - -o, --output [NAME] Output file. Default is CHANGELOG.md - --[no-]verbose Run verbosely. Default is true - --[no-]issues Include closed issues to changelog. Default is true - --[no-]issues-wo-labels Include closed issues without labels to changelog. Default is true - --[no-]pr-wo-labels Include pull requests without labels to changelog. Default is true - --[no-]pull-requests Include pull-requests to 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 - --[no-]compare-link Include compare link between older version and newer version. Default is true - --include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement' - --exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix' - --max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited. - --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. - -v, --version Print version number - -h, --help Displays Help + -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 required. You can generate it here: https://github.com/settings/tokens/new + -f, --date-format [FORMAT] Date format. Default is %d/%m/%y + -o, --output [NAME] Output file. Default is CHANGELOG.md + --[no-]verbose Run verbosely. Default is true + --[no-]issues Include closed issues to changelog. Default is true + --[no-]issues-wo-labels Include closed issues without labels to changelog. Default is true + --[no-]pr-wo-labels Include pull requests without labels to changelog. Default is true + --[no-]pull-requests Include pull-requests to 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 + --[no-]compare-link Include compare link between older version and newer version. Default is true + --include-labels x,y,z Issues only with that labels will be included to changelog. Default is 'bug,enhancement' + --exclude-labels x,y,z Issues with that labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix' + --max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited. + --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. + --future-release [RELEASE-VERSION] Put the unreleased changes in the specified release number. + -v, --version Print version number + -h, --help Displays Help ### GitHub token