README.md in logstash-output-scalyr-0.1.2 vs README.md in logstash-output-scalyr-0.1.3

- old
+ new

@@ -3,16 +3,16 @@ # [Scalyr output plugin for Logstash (Alpha release)] This plugin implements a Logstash output plugin that uploads data to [Scalyr](http://www.scalyr.com). -You can view documentation for this plugin [on the Scalyr website](https://www.scalyr.com/solutions/logstash). +You can view documentation for this plugin [on the Scalyr website](https://app.scalyr.com/solutions/logstash). # Quick start 1. Build the gem, run `gem build logstash-output-scalyr.gemspec` -2. Install the gem into a Logstash installation, run `/usr/share/logstash/bin/logstash-plugin install logstash-output-scalyr-0.1.2.gem` or follow the latest official instructions on working with plugins from Logstash. +2. Install the gem into a Logstash installation, run `/usr/share/logstash/bin/logstash-plugin install logstash-output-scalyr-0.1.3.gem` or follow the latest official instructions on working with plugins from Logstash. 3. Configure the output plugin (e.g. add it to a pipeline .conf) 4. Restart Logstash # Configuration @@ -303,5 +303,30 @@ ``` bundle exec rspec ``` in the root of the repo. + +# Releasing + +## Updating version + +Currently references to the version need to be manually updated, files to look in for this are `logstash-putput-scalyr.gemspec`, + `client.rb`, twice in the CircleCI `Dockerfile`, and under "Quick Start" in this `README.md`. + +The changelog should also be updated with the latest version and changes of note. + +## Releasing to RubyGems.org + +To deploy the current code on your machine run these commands: + +``` +bundle check --path vendor/bundle || bundle install --deployment +curl -u RUBY_USER:RUBY_PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials +chmod 0600 ~/.gem/credentials +bundle exec rake vendor +bundle exec rspec +bundle exec rake publish_gem +``` + +`RUBY_USER` and `RUBY_PASSWORD` should be replaced with the username and password to the RubyGems.org account you wish to release to, + these credentials should be found in Keeper.