chandler 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a929ae77a3668d71708404c4cd22f52a0518cd24
-  data.tar.gz: f6b4bccacec686b0bb566163d7ba9e5b348aa4c9
+SHA256:
+  metadata.gz: 7f01e9010051775612d968f772485ca04a12da95953f9289da00614b804eece1
+  data.tar.gz: 622e99b3d39732144759ca655f25ba2660fec07b7af58ea5437f7473e91a6f8e
 SHA512:
-  metadata.gz: 5c973d384f3b25c0b442736739833350e99fd1d56401ce71e75d5656cc53eb171b5894c81023166ebd132114425e3dd5a3b90c3b0f376d68e4289340bb46495c
-  data.tar.gz: 5de34aca5504e50ddad4964debf375065267e15f5db3df24954f7a96ccde6c38d8b2a86291b9b231c50d7fb2202d138693839863609fd706bf07cca1971a1180
+  metadata.gz: 5c90903cada9ff6f8b24f7fbfe87840631f087d9071c43efd3356db5f19956423916324c666a88db44ddb31242427b80851134baff88a63cee4f5634c552331b
+  data.tar.gz: 77e7ce541a295fbb1a8c564033fd27abd65541c6f8d338d86180b8c4b97c7b9eeb8acd1ca075e0f705730227f715b6e4658270055bf8b75106e38e92406d0aad

data/.rubocop.yml

@@ -4,6 +4,7 @@ AllCops:
   DisplayStyleGuide: true
   Exclude:
     - "*.gemspec"
+    - "vendor/**/*"
 
 Metrics/AbcSize:
   Exclude:
@@ -32,9 +33,23 @@ Style/Documentation:
 Style/DoubleNegation:
   Enabled: false
 
+Style/EndOfLine:
+  EnforcedStyle: lf
+
+Style/FileName:
+  Exclude:
+    - "Dangerfile"
+
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/IndentHeredoc:
+  Enabled: false
+
+Style/SignalException:
+  Exclude:
+    - "Dangerfile"
+
 Style/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: no_space
 

data/.travis.yml

@@ -1,11 +1,18 @@
+sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.1
-before_install: gem install bundler -v 1.13.1
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+  - ruby-head
+before_install:
+  - gem update --system
+  - gem install bundler --conservative --no-document -v "~> 2.0"
+  - gem install executable-hooks --conservative --no-document
 matrix:
   include:
-    # Run Danger only once, on 2.3.1
-    - rvm: 2.3.1
-      before_script: bundle exec danger
+    # Run Danger only once, on 2.6.0
+    - rvm: 2.6.0
+      script: bundle exec danger

data/CHANGELOG.md

@@ -8,6 +8,10 @@ chandler is in a pre-1.0 state. This means that its APIs and behavior are subjec
 
 * Your contribution here!
 
+## [0.8.0][] (2019-01-26)
+
+* **Drop support for EOL Rubies.** Chandler now requires Ruby >= 2.3.
+
 ## [0.7.0][] (2016-12-23)
 
 * [#23](https://github.com/mattbrictson/chandler/pull/23): Fix warnings reported when using Rake 12.0 - [@mattbrictson](https://github.com/mattbrictson)
@@ -55,7 +59,8 @@ chandler is in a pre-1.0 state. This means that its APIs and behavior are subjec
 * Initial release
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.7.0...HEAD
+[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/mattbrictson/chandler/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/mattbrictson/chandler/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/mattbrictson/chandler/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/mattbrictson/chandler/compare/v0.4.0...v0.5.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Matt Brictson
+Copyright (c) 2019 Matt Brictson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -10,23 +10,32 @@
 
 ### How does it work?
 
-chandler scans your git repository for version tags (e.g. `v1.0.2`), parses out the corresponding release notes for those tags from your CHANGELOG, and uploads those notes to the GitHub releases area via the GitHub API.
+chandler scans your git repository for version tags (e.g. `v1.0.2`), parses out the corresponding release notes for those tags from your `CHANGELOG`, and uploads those notes to your project's [GitHub Releases][gh-releases] via the GitHub API.
 
-Chandler makes reasonable assumptions as to the name of your CHANGELOG file, your project's GitHub repository URL, and the naming convention of your Git version tags. These can all be overridden with command line options.
+By default, chandler makes reasonable assumptions about:
+
+- the name of your `CHANGELOG` file,
+- your project's GitHub repository URL, and
+- the naming convention of your Git version tags.
+
+These can all be overridden with command line options.
 
 ### Why go through the trouble?
 
-GitHub's releases feature is a nice UI for browsing the history of your project and downloading snapshots of each version. It is also structured data that can be queried via GitHub's API, making it a available for third-party integrations. For example, [Sibbell][] can automatically send the release notes out to interested parties whenever you publish a new version.
+[GitHub Releases][gh-releases] are a nice UI for browsing the history of your project and downloading snapshots of each version. It is also structured data that can be queried via GitHub's API, making it a available for third-party integrations. For example, [Sibbell][] can automatically send the release notes out to interested parties whenever you publish a new version.
+
+But as a considerate developer, you also want a plain text `CHANGELOG` that travels with the code, can be edited collaboratively in pull requests, and so on.
 
-Of course, as a considerate developer you also want to have a plain text CHANGELOG that travels with the code, can be collaboratively edited in pull requests, and so on. But that means you need two copies of the same release notes!
+_But that means you need two copies of the same release notes!_ 😵
 
-chandler takes the hassle out of maintaining these two separate formats: your CHANGELOG is the authoritative source, and GitHub releases are updated with a simple `chandler` command.
+**chandler takes the hassle out of maintaining these two separate formats.**
+Your `CHANGELOG` is the authoritative source, and GitHub Releases are updated with a simple `chandler` command.
 
 ## Requirements
 
-* Ruby 2.1 or higher
-* Your project's CHANGELOG must be in Markdown with version numbers in the headings (similar to the format advocated by [keepachangelog.com](http://keepachangelog.com))
-* You must be an owner or collaborator of the GitHub repository to update its releases
+* Ruby 2.3 or higher
+* Your project's `CHANGELOG` must be in Markdown, with version numbers in the headings (similar to the format advocated by [keepachangelog.com](http://keepachangelog.com))
+* You must be an _owner_ or _collaborator_ of the GitHub repository to update its Releases
 
 ## Installation
 
@@ -36,7 +45,9 @@ chandler takes the hassle out of maintaining these two separate formats: your CH
 gem install chandler
 ```
 
-### 2. Configure .netrc or set ENV vars
+### 2. Configure credentials
+
+#### Option 1 - `.netrc`
 
 In order to access the GitHub API on your behalf, you must provide chandler with your GitHub credentials.
 
@@ -48,26 +59,30 @@ machine api.github.com
   password c0d3b4ssssss!
 ```
 
-Or expose an ENV variable: `CHANDLER_GITHUB_API_TOKEN` inside your CI.
+#### Option 2 - Set ENV variables
+
+Alternatively, just expose the ENV variable `CHANDLER_GITHUB_API_TOKEN` in your CI.
 
 For more security, you can use an OAuth access token in place of your password. [Here's how to generate one][access-token]. Make sure to enable `public_repo` scope for the token.
 
 
 ## Usage
 
-To push all CHANGELOG entries for all tags to GitHub, just run:
+To push all `CHANGELOG` entries for all tags to GitHub, just run:
 
 ```
 chandler push
 ```
 
-chandler will make educated guesses as to what GitHub repository to use, the location of the CHANGELOG, and the tags that represent releases. To see what will happen without actually making changes, run:
+chandler will make educated guesses as to what GitHub repository to use, the location of the `CHANGELOG`, and which tags represent releases.
+
+You can preview what will happen without actually making changes, using `--dry-run`:
 
 ```
 chandler push --dry-run
 ```
 
-To upload only a specific tag, `v1.0.2` for example:
+To upload only a specific tag (`v1.0.2`, for example):
 
 ```
 chandler push v1.0.2
@@ -94,7 +109,7 @@ Or like this:
 --github=https://github.mycompany.com/organization/project
 ```
 
-To authenticate, Chandler relies on your `~/.netrc`, as explained above. Replace `api.github.com` with the hostname of your GitHub Enterprise installation (`github.mycompany.com` in the example).
+To authenticate, Chandler relies on your `~/.netrc`, as explained above. GitHub Enterprise users simply need to replace `api.github.com` with the hostname of your GitHub Enterprise installation (`github.mycompany.com` in the example above).
 
 ## Rakefile integration
 
@@ -122,13 +137,14 @@ end
 task "release:rubygem_push" => "chandler:push"
 ```
 
-That's it! Now when you run `rake release`, your GitHub release notes will be updated automatically based on your CHANGELOG entries.
+That's it! Now when you run `rake release`, your GitHub Release notes will be updated automatically based on your `CHANGELOG` entries.
 
 And yes, chandler uses itself to automatically push its own [release notes][release-notes] to GitHub! Check out the [Rakefile](Rakefile).
 
 [Sibbell]: http://sibbell.com
 [access-token]: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
 [release-notes]: https://github.com/mattbrictson/chandler/releases
+[gh-releases]: https://help.github.com/articles/about-releases/
 
 ## Contributing
 

data/Rakefile

@@ -14,4 +14,4 @@ end
 
 RuboCop::RakeTask.new
 
-task :default => [:test, :rubocop]
+task :default => %i[test rubocop]

data/appveyor.yml

@@ -4,12 +4,13 @@ skip_tags: true
 
 environment:
   matrix:
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"
 
 install:
   - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - gem install bundler --no-document -v 1.10.4
+  - gem update --system
+  - gem install bundler --no-document
   - bundle install --retry=3
 
 test_script:

data/chandler.gemspec

@@ -20,15 +20,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.3.0"
+
   spec.add_dependency "netrc"
   spec.add_dependency "octokit", ">= 2.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "danger"
-  spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "minitest-reporters"
-  spec.add_development_dependency "mocha"
-  spec.add_development_dependency "rubocop", ">= 0.37.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.20"
+  spec.add_development_dependency "danger", "~> 5.11"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.10"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1"
+  spec.add_development_dependency "mocha", "~> 1.2"
+  spec.add_development_dependency "rubocop", "0.48.1"
 end

data/lib/chandler/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Chandler
-  VERSION = "0.7.0".freeze
+  VERSION = "0.8.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chandler
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-23 00:00:00.000000000 Z
+date: 2019-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netrc
@@ -44,112 +44,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.20
 - !ruby/object:Gem::Dependency
   name: danger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.48.1
 description: 
 email:
 - chandler@mattbrictson.com
@@ -204,15 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Syncs CHANGELOG entries to GitHub's release notes