https://github.com/upfluence/action-rubocop

Github action for ruby project
https://github.com/upfluence/action-rubocop

ci

Last synced: 25 days ago
JSON representation

Github action for ruby project

• Host: GitHub
• URL: https://github.com/upfluence/action-rubocop
• Owner: upfluence
• Created: 2020-06-30T13:36:48.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T15:44:00.000Z (almost 2 years ago)
• Last Synced: 2025-03-21T19:26:19.583Z (about 1 year ago)
• Topics: ci
• Language: Shell
• Size: 15.6 KB
• Stars: 0
• Watchers: 13
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

# 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@master

        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@master

        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