Merge pull request #1 from upfluence/ti-initale-version

v1

Author: Thomas ISAAC

.rubocop.yml

@@ -0,0 +1,32 @@
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 1000
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+    Max: 80
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - Gemfile.lock
+    - db/schema.rb

Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.6-alpine
+
+ENV REVIEWDOG_VERSION v0.10.0
+
+SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
+RUN apk add --update --no-cache build-base git
+RUN wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b /usr/local/bin/ $REVIEWDOG_VERSION
+
+COPY .rubocop.yml /.rubocop.yml
+COPY entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,2 +1,54 @@
-# action-rubocop
-Github action for ruby project
+
+# GitHub Action: Run linter onto upfluence ruby project
+
+## Release new version
+After pull request was approved and merged into master
+If code can work with old configuration, use same tag as before
+If your code include breaking change change label and inform all upfuence team about your changes.
+
+
+## Add this acton to your ruby project
+run command into your project directory
+```bash
+mkdir -p .github/workflows
+```
+Create file lint.yml
+```yml
+name: reviewdog
+on: [pull_request]
+
+jobs:
+  rubocop:
+    name: runner / rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+      - name: rubocop
+        uses: upfluence/action-rubocop@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+```
+If you need specific rubocop_extensions, you have to add key rubocop_extensions . By default rubocop_extensions value is 'rubocop-performance:1.5.1 rubocop-minitest'
+#### For example:
+```yml
+name: reviewdog
+on: [pull_request]
+
+jobs:
+  rubocop:
+    name: runner / rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+      - name: rubocop
+        uses: upfluence/action-rubocop@v1
+        with:
+          rubocop_extensions: rubocop-rails
+          github_token: ${{ secrets.github_token }}
+
+```
+
+## Overriding .rubocop.yml
+ If you need to override .rubocop.yml provide by this tool, you can create .rubocop.yml into your repository and it will be use by rubocop

action.yml

@@ -0,0 +1,19 @@
+name: 'Run rubocop linter with reviewdog'
+description: 'Run rubocop as github action'
+author: 'thomas isaac (upfluence)'
+inputs:
+  github_token:
+    description: 'GITHUB_TOKEN.'
+    required: true
+  rubocop_extensions:
+    description: 'Rubocop extensions'
+    default: 'rubocop-performance:1.5.1 rubocop-minitest'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.github_token }}
+    - ${{ inputs.rubocop_extensions }}
+branding:
+  icon: 'check-circle'
+  color: 'red'

entrypoint.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+get_version_or_null() {
+  if [ -n "$1" ]; then
+    echo "-v $1"
+  fi
+}
+
+cd "${GITHUB_WORKSPACE}/" || exit 1
+
+export REVIEWDOG_GITHUB_API_TOKEN="${INPUT_GITHUB_TOKEN}"
+export RUBOCOP_VERSION=''
+export FILTER_MODE=added
+export FAILED_ON_ERROR=true
+export LEVEL=error
+export REPORTER=github-pr-review
+
+gem install -N rubocop $(get_version_or_null $RUBOCOP_VERSION)
+
+echo $INPUT_RUBOCOP_EXTENSIONS | xargs gem install -N
+
+#Check if rubocop is present into repository
+[ -f .rubocop.yml ] || cp /.rubocop.yml .
+
+rubocop --force-exclusion \
+  | reviewdog -f=rubocop \
+      -name="rubocop-linter" \
+      -reporter="${REPORTER}" \
+      -filter-mode="${FILTER_MODE}" \
+      -fail-on-error="${FAILED_ON_ERROR}" \
+      -level="${LEVEL}"