Skip to content

Add --max-issues argument to limit requests #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

sneal
Copy link
Contributor

@sneal sneal commented Mar 21, 2015

This addresses issue #71 by providing a configurable limit on the number of issues to retrieve. By default this limits the number of issues to 500 which should help users stay under the GitHub API limit and keep change logs from growing ridiculous in size for older repos.

This addresses issue 71 by providing a configurable limit on the number of issues to retrieve. By default this limits the number of issues to 500 which should help users stay under the GitHub API limit and keep change logs from growing ridiculous in size for older repos.
@skywinder
Copy link
Member

@sneal hi, thanks for participating! It's a good addition, that make more flexibility in change log generation. I have a couple proposal before merge:

  1. I think it's better to not limit users with 500 issues by default. (it depends of repo, but usually it can be work with more than 1000 issues). It's better to set --max-issues to nil by default, and limit it only in case, if user explicit set this number.
  2. It will be nice to mention about this option in FAQ section, for example with topic:
    "I got warning Warning: GitHub API rate limit exceed (5000 per hour), change log may not contain some issues. What it means and what I should do?"
    And as answer: add suggestion to run script with your key: --max-issues 1 hour later (to reset rate limit), to get more predictive result.

- defaulted max issues to be unlimited in number allowing user to optionally limit issues returned
- added FAQ section on rate limiting and API rate limit exceeded warning
@skywinder
Copy link
Member

@sneal Thanks, awesome work! 👍

skywinder added a commit that referenced this pull request Mar 24, 2015
Add --max-issues argument to limit requests
@skywinder skywinder merged commit d6cbfe3 into github-changelog-generator:master Mar 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants