Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
code

GitHub Action

RuboCop Linter Action

v3.0.0.rc1 Pre-release

RuboCop Linter Action

code

RuboCop Linter Action

A GitHub Action that lints your Ruby or Ruby on Rails code with RuboCop

Installation

Copy and paste the following snippet into your .yml file.

              

- name: RuboCop Linter Action

uses: andrewmcodes-archive/[email protected]

Learn more about this action in andrewmcodes-archive/rubocop-linter-action

Choose a version

Rubocop Linter Action Linters Tests Changelog Build

Version Number Documentation Status All Contributors

Rubocop Linter Action

A GitHub Action to run Rubocop against your codebase and output the results in the GitHub Checks UI.

Introduction

GitHub Actions are an amazing new tool that can dramatically improve productivity while using the GitHub platform. While it is not hard to write a custom GitHub action to run Rubocop on your codebase, this action takes that functionality one step further using the checks API. After the Rubocop Linter Action runs Rubocop against your code, it will create annotations that you can easily view, matched up with the offending code.

Since GitHub actions and the checks API are continually changing, it is possible that there will be breaking API changes that affect this action. If so, please open an issue and I will look into it as soon as I can.

Usage

Documentation

Please view the official documentation for more detailed instructions, including how to setup and use a configuration file to customize the action. Note that you can set the version for the documentation you are viewing in the bottom right.

Quickstart

Default usage, similar to running gem install rubocop && rubocop from your command line:

- name: Rubocop Linter Action
  uses: andrewmcodes/[email protected]
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Screenshots

Rubocop Linter Checks Overview Rubocop Linter File Annotation

Community

Changelog

View our Changelog

Contributing

Contributing Guide

Code of Conduct

Code of Conduct

License

MIT

Other Ruby GitHub Actions

Contributors

Thanks goes to these wonderful people (emoji key):


Andrew Mason

πŸš‡ πŸ‘€ πŸ“– πŸ’»

Miguel Savignano

πŸš‡ ⚠️ πŸ’»

Dan McGregor

πŸ“–

amerritt14

πŸ’»

Brian Bugh

πŸ’» ⚠️

Reid Beels

πŸ’» ⚠️

Christopher Pezza

πŸ’» πŸ“– πŸš‡

Mark Havekes

πŸ›

David Martinez

πŸ’»

Chris Oliver

πŸ‘€ πŸ€”

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