Improve docs and add release to workflow

.github/workflows/build.yml

@@ -1,6 +1,6 @@
 name: build
 
-on: push
+on: [push, create]
 
 jobs:
   build_matrix:
@@ -47,3 +47,25 @@ jobs:
       - name: Dummy for branch status checks
         run: |
           echo "build complete"
+
+  release:
+    needs: build
+    if: contains(github.ref, 'tags') && github.event_name == 'create'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+      - name: Prepare Gemfury
+        run: |
+          mkdir -p ~/.gem
+          echo -e "---\n:fury_push_token: ${{ secrets.GEMFURY_TOKEN }}" > ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+
+      - name: Build Gem
+        run: |
+          gem build *.gemspec
+
+      - name: Publish Gem
+        run: |
+          gem push *.gem --key fury_push_token \
+                         --host https://push.fury.io/babbel

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2020-12-18
+### Added
+- Core Plugin
+- Telemetry generation
+- IO Target with JSON formatter
+- Datadog Statsd Target

README.md

@@ -82,7 +82,21 @@ Just be mindful that if the API takes long to call, it will slow down frequency
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Release
+
+All gem releases are manual, in order to create a new release follow:
+
+1. Create new PR (this could be included in feature PR, if it's meant to be released)
+   - update `VERSION`, we use [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+   - update `CHANGELOG`
+   - merge
+2. Draft new release via Github Releases
+   - use `v#{VERSION}` as a tag, i.e. `v0.1.0`
+   - add release notes based on the Changelog
+   - create
+3. Gem will get automatically published to given rubygems server
 
 ## Contributing