This repository has been archived on 2023-10-25. You can view files and clone it, but cannot push or open issues or pull requests.
allcontributors[bot] 715d4ecef7 docs: add andrewmcodes as a contributor (#24)
* docs: update README.md

* docs: update .all-contributorsrc
2019-10-28 20:51:58 -04:00

3.1 KiB

rubocop linter actions banner All Contributors

Rubocop Linter Action

version number

GitHub Action to run Rubocop against your code and create annotations in the UI.

NOTE: due to the GitHub Check Runs API, we can only return 50 annotations per run. See here for more info.

Usage

Add the following to your GitHub action workflow:

- name: Rubocop Linter
  uses: andrewmcodes/rubocop-linter-action@v0.2.0
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Example Workflow

name: Rubocop

on:
  pull_request:
    branches:
      - '*'
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Rubocop Linter
      uses: andrewmcodes/rubocop-linter-action@v0.2.0
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Screenshots

example GitHub Action UI

Contributing

Contributing Guide

Code of Conduct

Code of Conduct

License

MIT

Recognition

This project was originally forked from gimenete/rubocop-action. Many thanks to Alberto Gimeno for creating this project.

Contributors

Thanks goes to these wonderful people (emoji key):

Miguel Savignano
Miguel Savignano

🚇 ⚠️ 💻
Andrew Mason
Andrew Mason

🚇 👀 📖 💻

This project follows the all-contributors specification. Contributions of any kind welcome!