github_changelog_generator 1.15.0 → 1.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ee18824228b1ec5cade4842046046452afa0c4a0cab01ee3c52f86b60206cfb
-  data.tar.gz: 2c6df785e4d34d416255d1949e58a3a2668453e1a8246ae706989ddf17442bd7
+  metadata.gz: 96d97ec2074cb54d75216a93b42f41a6216a418c1b0e926ab55a0cb9cb32a09b
+  data.tar.gz: 75faf09151502f8f2d3cd4a15da37b26648ed504d42e3829ad95d1d7c71a9268
 SHA512:
-  metadata.gz: cd20b1b8916d83db50428dbe899c346d1a2b2ca1b26427fdc9997b2edf7604db530b9372c4461f443f4e7f0fc0133c6bd01b8643b1ec066cd1c80c4d0657ca3e
-  data.tar.gz: 41169d141f512dbecc520251f50fb9db63d4df6160621c5b8598dabf31095d9b75ae7b3aeab1bc126ac9fc5e5a71131026235bce4acb8661ed29744e6a246fa0
+  metadata.gz: 9f6adfd28ffcb632837a9d037b0677f6527b03d6a8c787ab9f65b2981b740e1bd478d0f0b64b76f8fab93d00d101b9b5fb80cb86ba7d722c98b0728534485cfc
+  data.tar.gz: 81ee9e88cd5efa0c8acc60ce9f2a1571ea72fb9d9b096af07236477ff560e7561bd3eef31a3c9b26a5bdd6edba2656fe18b32509a7fbe8e40325f4974a94651a

data/README.md

@@ -5,11 +5,6 @@
 
 # github-changelog-generator ![GitHub Logo](../master/images/logo.jpg)
 
-#### Update:
-
-🖖 Keep it alive: We need more Collaborators to github-changelog-generator [#727](https://github.com/github-changelog-generator/github-changelog-generator/issues/727)
-
----
 <!--
 To update TOC, please run:
 > doctoc ./README.md --github
@@ -72,16 +67,34 @@ Install the gem like:
 Depending on your system, you _may_ need to run the shell as an Administrator (Windows),
 or use `sudo gem install github_changelog_generator` (Linux).
 
-## Running with Docker
 
-Using [Docker](https://www.docker.com/products/docker-desktop) is an alternative to installing Ruby and the gem.
+## Usage
+
+
+### Running with CLI:
 
-`ferrarimarco` has made a Docker image available that you can use.
+	   github_changelog_generator -u github_username -p github_project
+
+
+### Running with Docker
+
+Using [Docker](https://www.docker.com/products/docker-desktop) is an alternative to installing Ruby and the gem.
 
 Example invocation:
 
     $ docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator
 
+
+
+- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
+
+       $ github_changelog_generator --github-site="https://github.yoursite.com" \
+                                  --github-api="https://github.yoursite.com/api/v3/"
+
+
+This generates a `CHANGELOG.md`, with pretty Markdown formatting.
+
+
 ## Output example
 
 - Look at **[CHANGELOG.md](https://github.com/github-changelog-generator/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
@@ -109,25 +122,6 @@ Example invocation:
 >
 > - support enterprise github via command line options [\#42](https://github.com/github-changelog-generator/Github-Changelog-Generator/pull/42) ([glenlovett](https://github.com/glenlovett))
 
-
-## Usage
-
--  Run this:
-
-	   $ github_changelog_generator -u github_username -p github_project
-
-	or, on the 1.14.x (current stable release)
-
-	   $ github_changelog_generator github_username/github_project
-
-
-- For Github Enterprise repos, specify *both* `--github-site` and `--github-api` options:
-
-       $ github_changelog_generator --github-site="https://github.yoursite.com" \
-                                  --github-api="https://github.yoursite.com/api/v3/"
-
-This generates a `CHANGELOG.md`, with pretty Markdown formatting.
-
 ### Params
 
 Print help for all command-line options to learn more details:
@@ -150,7 +144,7 @@ since-tag=1.0.0
 
 ### GitHub token
 
-GitHub only allows 50 unauthenticated requests per hour.
+GitHub only allows **50 unauthenticated requests per hour**.
 
 Therefore, it's recommended to run this script with authentication by using a **token**.
 
@@ -161,7 +155,7 @@ Here's how:
     - Run the script with `--token <your-40-digit-token>`; **OR**
     - Set the `CHANGELOG_GITHUB_TOKEN` environment variable to your 40 digit token
 
-You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `~/.bash_profile` or `~/.zshrc`):
+You can set an environment variable by running the following command at the prompt, or by adding it to your shell profile (e.g., `.env`, `~/.bash_profile`, `~/.zshrc`, etc):
 
     export CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»"
 
@@ -290,27 +284,6 @@ I'm not trying to compare the quality of handwritten and auto-generated logs. Th
 
 An auto-generated changelog really helps, even if you manually fill in the release notes!
 
-For example:
-
-When you find a closed bug, it is very useful to know which release fixed it.
-So that you can easily find the issue by \# in `CHANGELOG.md`.
-
-- It's not quite as easy to find this in handwritten releases notes.
-- A generated file saves you the trouble of remembering everything;
-  sometimes people forget to add things to a handwritten file.
-
-Ultimately, I think GitHub Releases are ideal for end-users.
-Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers.
-Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination.
-
-- ***I got an "API rate limit exceeded" error message. What does this mean?***
-
-GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests).
-
-If you're seeing this warning, please do the following:
-
-1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000.
-2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000`
 
 - ***My Ruby version is very old, can I use this?***
 
@@ -349,6 +322,9 @@ We have collected notes on how to contribute to this project in [CONTRIBUTING.md
 
 [CONTRIBUTING.md]: CONTRIBUTING.md
 
+## Contact us
+[Join the chat at gitter : github-changelog-generator](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 ## License
 
 Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/github_changelog_generator/octo_fetcher.rb

@@ -16,7 +16,7 @@ module GitHubChangelogGenerator
     GH_RATE_LIMIT_EXCEEDED_MSG = "Warning: Can't finish operation: GitHub API rate limit exceeded, changelog may be " \
     "missing some issues. You can limit the number of issues fetched using the `--max-issues NUM` argument."
     NO_TOKEN_PROVIDED = "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found. " \
-    "This script can make only 50 requests to GitHub API per hour without token!"
+    "This script can make only 50 requests to GitHub API per hour without a token!"
 
     # @param options [Hash] Options passed in
     # @option options [String] :user GitHub username
@@ -187,12 +187,14 @@ Make sure, that you push tags to remote repo via 'git push --tags'"
     def fetch_events_async(issues)
       i       = 0
       threads = []
+      # Add accept option explicitly for disabling the warning of preview API.
+      preview = { accept: Octokit::Preview::PREVIEW_TYPES[:project_card_events] }
 
       issues.each_slice(MAX_THREAD_NUMBER) do |issues_slice|
         issues_slice.each do |issue|
           threads << Thread.new do
             issue["events"] = []
-            iterate_pages(@client, "issue_events", issue["number"]) do |new_event|
+            iterate_pages(@client, "issue_events", issue["number"], preview) do |new_event|
               issue["events"].concat(new_event)
             end
             issue["events"] = issue["events"].map { |event| stringify_keys_deep(event.to_hash) }

data/lib/github_changelog_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitHubChangelogGenerator
-  VERSION = "1.15.0"
+  VERSION = "1.15.2"
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: github_changelog_generator
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.15.2
 platform: ruby
 authors:
 - Petr Korolev
 - Olle Jonsson
+- Marco Ferrari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -198,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Script, that automatically generate changelog from your tags, issues, labels