github_fast_changelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 904580ecd6a45560a9906a3bbbb8f545e1137995611ec1610fed62a5cf97aa93
+  data.tar.gz: c54b2ba68b4030e25906dae4ad4525739fa6ec8d5502eeb0fa1c7c1d4d11b97e
+SHA512:
+  metadata.gz: '09f3ca3944d2cc3ee14d65d40ff3d813c941485705fb4eec55e4251acd7661ee94818c51aced13db1153d608d3bf49ab9049be5129f406faf9855c609da94f96'
+  data.tar.gz: f0f05ec02fdc44df3f82e7184cdf3e022de71b3a2d8f9e14b1c2e27de5420be739d61fc7fe9eaa7067da125b060b4ad94d31bab4303357ed3d9d7fe6671adf6d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at john@hawthorn.email. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in github_fast_changelog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 John Hawthorn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# GithubFastChangelog
+
+Uses GitHub's v4 GraphQL API to generate a CHANGELOG from PRs matching a list of commits.
+
+I used to use [GitHub Changelog
+Generator](https://github.com/github-changelog-generator/github-changelog-generator)
+(which is a better and way more complete project), but the project I worked on
+was too large (several thousand PRs) and always hit github's rate limit.
+
+This project uses GitHub's v4 GraphQL API to query the PRs very efficiently and shouldn't ever hit the rate limit
+
+## Installation
+
+    $ gem install github_fast_changelog
+
+## Usage
+
+This expects a list of commits (some of which should match the merge commit of a PR) on STDIN. Writes markdown to STDOUT.
+
+    $ export GITHUB_ACCESS_TOKEN=....
+    $ git rev-list v2.4...v2.5 | github_fast_changelog example/github_repo > CHANGELOG.md
+
+
+Output is:
+
+```
+- Add usage instructions to README [#1](https://github.com/jhawthorn/github_fast_changelog/pull/1) ([jhawthorn](https://github.com/jhawthorn))
+```
+
+Rendered:
+
+- Add usage instructions to README [#1](https://github.com/jhawthorn/github_fast_changelog/pull/1) ([jhawthorn](https://github.com/jhawthorn))
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/github_fast_changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GithubFastChangelog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jhawthorn/github_fast_changelog/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github_fast_changelog"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/github_fast_changelog

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+def usage
+  $stderr.puts "Usage: git rev-list v2.4...v2.5 | #$0 example/github_repo > CHANGELOG.md"
+  exit 1
+end
+
+if ARGV.length != 1 || /[-_\w]+\/[-_.\w]+/ !~ ARGV[0] || $stdin.isatty
+  usage
+end
+
+commits = $stdin.read.split
+
+if commits.empty?
+  usage
+end
+
+output = $stdout
+logger = output.isatty ? File.open(File::NULL, "w") : $stderr
+
+project = ARGV[0]
+owner, name = project.split('/', 2)
+
+def format_pull(pull)
+  <<~MD
+    - #{pull.title} [\##{pull.number}](#{pull.url}) ([#{pull.author.login}](#{pull.author.url}))
+  MD
+end
+
+require 'github_fast_changelog'
+
+logger.puts "Generating changelog"
+GithubFastChangelog.each_pull_request(owner: owner, name: name) do |pull|
+  in_release = pull.merge_commit && commits.include?(pull.merge_commit.oid)
+  if in_release
+    md = format_pull(pull)
+    output.puts(md)
+    logger << "#"
+  else
+    logger << "."
+  end
+  logger.flush
+end
+logger.puts ""

data/github_fast_changelog.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github_fast_changelog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_fast_changelog"
+  spec.version       = GithubFastChangelog::VERSION
+  spec.authors       = ["John Hawthorn"]
+  spec.email         = ["john@hawthorn.email"]
+
+  spec.summary       = %q{Generates a CHANGELOG based on GitHub PRs}
+  spec.description   = %q{Uses GitHub's v4 GraphQL API to generate a CHANGELOG from PRs matching a list of commits}
+  spec.homepage      = "https://github.com/jhawthorn/github_fast_changelog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "graphql", "~> 1.6"
+  spec.add_dependency "graphql-client"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/github_fast_changelog.rb

@@ -0,0 +1,70 @@
+require 'graphql/client'
+require 'graphql/client/http'
+
+require "github_fast_changelog/version"
+
+module GithubFastChangelog
+  HTTP = GraphQL::Client::HTTP.new("https://api.github.com/graphql") do
+    def headers(context)
+      if token = ENV['GITHUB_ACCESS_TOKEN']
+        { "Authorization" => "Bearer #{token}" }
+      else
+        fail "Missing ENV GITHUB_ACCESS_TOKEN"
+      end
+    end
+  end
+  Schema = GraphQL::Client.load_schema(HTTP)
+  Client = GraphQL::Client.new(schema: Schema, execute: HTTP)
+
+  MergedPullsQuery = Client.parse <<-GRAPHQL
+    query($before: String, $owner: String!, $name: String!) {
+      repository(owner: $owner, name: $name) {
+        name
+        pullRequests(last:100, before: $before, states:MERGED) {
+          pageInfo {
+            endCursor
+            hasNextPage
+            hasPreviousPage
+            startCursor
+          }
+          edges {
+            node {
+              id
+              number
+              title
+              url
+              author {
+                login
+                url
+              }
+              mergedAt
+              mergeCommit {
+                oid
+              }
+            }
+          }
+        }
+      }
+    }
+  GRAPHQL
+
+  def self.each_pull_request(owner:, name:)
+    cursor = nil
+    loop do
+      result = Client.query(MergedPullsQuery, variables: {
+        before: cursor,
+        owner: owner,
+        name: name
+      })
+      data = result.data.repository.pull_requests
+      more = data.page_info.has_previous_page
+      cursor = data.page_info.start_cursor
+
+      data.edges.reverse.map do |edge|
+        yield edge.node
+      end
+
+      break unless more
+    end
+  end
+end

data/lib/github_fast_changelog/version.rb

@@ -0,0 +1,3 @@
+module GithubFastChangelog
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: github_fast_changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Hawthorn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: graphql-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Uses GitHub's v4 GraphQL API to generate a CHANGELOG from PRs matching
+  a list of commits
+email:
+- john@hawthorn.email
+executables:
+- github_fast_changelog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/github_fast_changelog
+- github_fast_changelog.gemspec
+- lib/github_fast_changelog.rb
+- lib/github_fast_changelog/version.rb
+homepage: https://github.com/jhawthorn/github_fast_changelog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Generates a CHANGELOG based on GitHub PRs
+test_files: []