Skip to content

A GitHub Action for running Pronto code review automation

License

Notifications You must be signed in to change notification settings

Slaurmagan/pronto-ruby

 
 

Repository files navigation

Your all-in-one ruby Pronto runner.

This GitHub Action runs Pronto runners on your Ruby project diffs and reports back with a GitHub Check Run.

check runs

annotations

Runners

The docker image of this Action includes the following Pronto Runners:

  • brakeman
  • bundler_audit
  • eslint_npm
  • fasterer
  • flay
  • poper
  • rails_best_practices
  • rails_schema
  • rails_data_schema
  • reek
  • rubocop
  • scss
  • yamllint
  • stylelint

Inputs

name description default
runners Space-separated list of pronto runners to run. Must be the preinstalled runners from the list above. rubocop
target The git target pronto will diff against (-c) origin/master

Secrets

A GitHub token is available by default when using actions, but you must include it in the env map for this Action to use when creating a check run.

Be sure to include the ENV variable in your job step:

    - uses: adwerx/pronto-ruby
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

That's it!

Configuration

Pronto can be configured via the .pronto.yml configuration file in your repo.

Example

With the defaults (only rubocop):

name: Pronto

on:
  - push
  - pull_request

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - run: git fetch origin master --depth=1
      - uses: adwerx/pronto-ruby@v2.8
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

With specific runners:

name: Pronto
# ...
      with:
        runners: >-
          rubocop rails_schema yamllint

With eslint_npm runner using locally installed eslint:

name: Pronto
# ...
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - run: git fetch origin master --depth=1
      - uses: actions/setup-node@v1
      - run: yarn install --ignore-optional --ignore-scripts --frozen-lockfile --non-interactive
      - uses: adwerx/pronto-ruby@v2.8
        with:
          runners: eslint_npm # ...
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Development / Contributions

See CONTRIBUTING.md

About

A GitHub Action for running Pronto code review automation

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 93.8%
  • Dockerfile 3.6%
  • Makefile 2.4%
  • Shell 0.2%