https://github.com/andrewmcodes/standardrb-action

StandardRB Action: A GitHub Action to run StandardRB against your code!
https://github.com/andrewmcodes/standardrb-action

action actions annotations github-actions lint linter ruby ruby-on-rails standard standard-action standard-linter-action standardrb standardrb-action standardrb-linter-action workflow

Last synced: 2 days ago
JSON representation

StandardRB Action: A GitHub Action to run StandardRB against your code!

• Host: GitHub
• URL: https://github.com/andrewmcodes/standardrb-action
• Owner: andrewmcodes
• License: mit
• Created: 2019-11-07T02:57:40.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-02T01:53:00.000Z (5 months ago)
• Last Synced: 2024-12-14T15:15:33.382Z (13 days ago)
• Topics: action, actions, annotations, github-actions, lint, linter, ruby, ruby-on-rails, standard, standard-action, standard-linter-action, standardrb, standardrb-action, standardrb-linter-action, workflow
• Language: Ruby
• Homepage:
• Size: 398 KB
• Stars: 33
• Watchers: 1
• Forks: 23
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
> [!CAUTION]

> This action is no longer maintained. Instead, consider this fork that is maintained by the Standard Ruby team at [standardrb/standard-ruby-action](https://github.com/standardrb/standard-ruby-action)

# :white_check_mark: StandardRB Action

A GitHub Action to run [StandardRB](https://github.com/testdouble/standard) against your code and create annotations in the GitHub UI.

## :page_facing_up: 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 StandardRB on your codebase, this action takes that functionality one step further using the checks API. After the StandardRB Linter Action runs StandardRB against your code, it will create annotations that you can easily view, matched up with the offending code.

## :bulb: Usage

Add the following to your GitHub action workflow to use StandardRB Linter Action:

```yaml

- name: StandardRB Linter

  uses: andrewmcodes/[email protected]

  env:

    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

### :package: Example Workflow

Here is an example workflow file incorporating StandardRB Linter Action:

```yaml

name: StandardRB

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v4

    - name: StandardRB Linter

      uses: andrewmcodes/[email protected]

      env:

        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## :warning: Gotchas

Due to the GitHub Check Runs API, we can only return 50 annotations per run. See [here](https://developer.github.com/v3/checks/runs/#output-object) for more info.

This is not an issue if you remove this action from your workflow and replace with `bundle exec standardrb --format github --parallel` as mentioned in the caution above.

## :camera_flash: Screenshots

![StandardRB Action Checks Overview](screenshots/check-overview.png)

![StandardRB Action File Annotation](screenshots/file-annotation.png)

## :bookmark: Changelog

[View our Changelog](/CHANGELOG.md)

## :sos: Contributing

[Contributing Guide](/CONTRIBUTING.md)

## :rotating_light: Code of Conduct

[Code of Conduct](/CODE_OF_CONDUCT.md)

## :copyright: License

[MIT](/LICENSE.md)