First version of formatter

Author: StefSchenkelaars

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+on: [push]
+jobs:
+  reviewdog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+      - name: rubocop
+        uses: reviewdog/action-rubocop@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          reporter: github-check
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+      - name: Setup caching for ruby gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Install gems
+        run: |
+          gem install bundler:2.1.4 --no-doc
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run RSpec
+        run: bundle exec rspec

.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Rubymine stuff
+.rakeTasks

.rspec

@@ -1,3 +1,3 @@
---format documentation
 --color
 --require spec_helper
+--format RSpec::Github::Formatter

.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+# A top class comment is not needed for this simple gem
+Style/Documentation:
+  Enabled: false
+
+# 80 chars is really short. Screens got bigger you know.
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb' # Specs just have large blocks
+    - '*.gemspec'    # Is just one block

.travis.yml

@@ -1,7 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rspec-github.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

Gemfile

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    rspec-github (1.0.0.develop)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.0)
+  rspec-github!
+  rubocop (~> 0.81.0)
+
+BUNDLED WITH
+   2.1.4

Gemfile.lock

@@ -1,40 +1,40 @@
 # Rspec::Github
+[RSpec](https://rspec.info/) formatter compatible with [GitHub Action](https://github.com/features/actions)'s annotations. It supports multiline errors and will set pending specs as warnings:
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/github`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+![screenshot.png](docs/screenshot.png)
 
 ## Installation
-
-Add this line to your application's Gemfile:
-
+Add the gem to your application's `Gemfile` `test` group:
 ```ruby
-gem 'rspec-github'
+group :test do
+  gem 'rspec-github', require: false
+end
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install rspec-github
+And then of course install the gem by executing:
+```shell script
+bundle install
+```
 
 ## Usage
+You can specify the formatter with a command line argument:
+```shell script
+rspec --format RSpec::Github::Formatter
+```
 
-TODO: Write usage instructions here
+And to always run it with this formatter, you can set it in the `.rspec` file:
+```
+# other configuration
+--format RSpec::Github::Formatter
+```
 
 ## Development
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. 
+Publishing a new version is handled by the [publish workflow](.github/workflows/publish.yml). This workflow publishes a GitHub release to [rubygems](https://rubygems.org/) with the version defined in the release. 
 
-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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-github.
-
+### Usefull references
+- https://help.github.com/en/actions/reference/development-tools-for-github-actions
+- https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).