Merge pull request #16 from twingly/changelog

Generate Changelog (with instructions to update it)

Author: jage

CHANGELOG.md

@@ -0,0 +1,51 @@
+# Change Log
+
+## [2.0.0](https://github.com/twingly/twingly-analytics-api-ruby/tree/2.0.0) (2015-09-14)
+[Full Changelog](https://github.com/twingly/twingly-analytics-api-ruby/compare/1.0.1...2.0.0)
+
+**Implemented enhancements:**
+
+- Release gem to rubygems.org [\#10](https://github.com/twingly/twingly-analytics-api-ruby/issues/10)
+
+**Merged pull requests:**
+
+- Improve time pagination \(breaking compatibility for Query\#start\_time and Query\#end\_time\) [\#15](https://github.com/twingly/twingly-analytics-api-ruby/pull/15) ([jage](https://github.com/jage))
+
+## [1.0.1](https://github.com/twingly/twingly-analytics-api-ruby/tree/1.0.1) (2015-04-29)
+[Full Changelog](https://github.com/twingly/twingly-analytics-api-ruby/compare/1.0.0...1.0.1)
+
+**Fixed bugs:**
+
+- Support Ruby 2.2 [\#12](https://github.com/twingly/twingly-analytics-api-ruby/issues/12)
+- HTTPS broke compatibility with Ruby 1.9.3 [\#8](https://github.com/twingly/twingly-analytics-api-ruby/issues/8)
+
+**Closed issues:**
+
+- Use the rspec-its gem [\#11](https://github.com/twingly/twingly-analytics-api-ruby/issues/11)
+
+**Merged pull requests:**
+
+- Fix deprecations [\#14](https://github.com/twingly/twingly-analytics-api-ruby/pull/14) ([walro](https://github.com/walro))
+- Support Ruby 2.2 [\#13](https://github.com/twingly/twingly-analytics-api-ruby/pull/13) ([dentarg](https://github.com/dentarg))
+- Use Faraday instead of Net::HTTP directly [\#9](https://github.com/twingly/twingly-analytics-api-ruby/pull/9) ([jage](https://github.com/jage))
+
+## [1.0.0](https://github.com/twingly/twingly-analytics-api-ruby/tree/1.0.0) (2014-10-30)
+**Implemented enhancements:**
+
+- Use HTTPS for API access [\#7](https://github.com/twingly/twingly-analytics-api-ruby/issues/7)
+- Remove swedish comment [\#5](https://github.com/twingly/twingly-analytics-api-ruby/issues/5)
+- Rewrite history to remove huge vcr-cassettes [\#4](https://github.com/twingly/twingly-analytics-api-ruby/issues/4)
+- Remove humongous vcr cassettes [\#1](https://github.com/twingly/twingly-analytics-api-ruby/issues/1)
+
+**Closed issues:**
+
+- Add a LICENSE [\#6](https://github.com/twingly/twingly-analytics-api-ruby/issues/6)
+- Wrap lines at 72 characters [\#2](https://github.com/twingly/twingly-analytics-api-ruby/issues/2)
+
+**Merged pull requests:**
+
+- Refactor to improve readability [\#3](https://github.com/twingly/twingly-analytics-api-ruby/pull/3) ([jage](https://github.com/jage))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

README.md

@@ -44,6 +44,13 @@ Too learn more about the capabilities of this API you should read the [Twingly A
 * API key, contact sales@twingly.com to get one
 * Ruby 1.9, 2.0, 2.1, 2.2
 
+## Development and release
+
+* Bump version in `lib/twingly-analytics/version.rb`, follow [Semantic Versioning 2.0.0](http://semver.org/)
+* Create a git tag and push to GitHub
+* Build and release gem to https://rubygems.org/
+* Make sure the master branch has an up-to-date changelog. Generate with `rake changelog`. Set `CHANGELOG_GITHUB_TOKEN` to a personal access token to increase the API rate limit. (The changelog uses [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/))
+
 ## License
 
 The MIT License (MIT)

Rakefile

@@ -1,15 +1,21 @@
-require 'rake'
-require 'bundler/gem_tasks'
+require "rake"
+require "bundler/setup"
+require "bundler/gem_tasks"
 
 desc "Run specs"
 task :spec do
-  require 'bundler/setup'
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec) do |t|
     t.rspec_opts = %w(-fd -c)
   end
 end
 
+require "github_changelog_generator/task"
+GitHubChangelogGenerator::RakeTask.new(:changelog) do |config|
+  config.user = "twingly"
+  config.project = "twingly-analytics-api-ruby"
+end
+
 desc "Synonym for spec"
 task :test => :spec
 desc "Synonym for spec"

twingly-analytics-api-ruby.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr", "~> 2.6"
   spec.add_development_dependency "webmock", "~> 1.0"
   spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "github_changelog_generator", "~> 1.8"
 end