https://github.com/rubyonworld/pronto-ruby

Your all-in-one ruby Pronto runner.
https://github.com/rubyonworld/pronto-ruby

pronto ruby runner

Last synced: about 5 hours ago
JSON representation

Your all-in-one ruby Pronto runner.

• Host: GitHub
• URL: https://github.com/rubyonworld/pronto-ruby
• Owner: RubyOnWorld
• License: mit
• Created: 2022-09-27T15:32:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T11:08:23.000Z (over 1 year ago)
• Last Synced: 2024-10-05T10:46:36.357Z (about 1 month ago)
• Topics: pronto, ruby, runner
• Language: Ruby
• Homepage:
• Size: 1.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Your all-in-one ruby Pronto runner.

This [GitHub Action](https://github.com/features/actions) runs [Pronto](https://github.com/prontolabs/pronto) [runners](https://github.com/prontolabs/pronto#runners) on your Ruby project diffs and reports back with a [GitHub Check Run](https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/).

![check runs](static/checkrun.png)

![annotations](static/annotations.png)

# Runners

The docker image of this Action includes the following [Pronto Runners](https://github.com/prontolabs/pronto#runners):

- brakeman

- bundler_audit

- eslint_npm

- fasterer

- flay

- ~~poper~~ (removed—no support for pronto 0.11)

- rails_best_practices

- rails_schema

- ~~rails_data_schema~~ (removed—no support for pronto 0.11)

- 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:

```yaml

    - 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):

```yaml

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/[email protected]

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

With specific runners:

```yaml

name: Pronto

# ...

      with:

        runners: >-

          rubocop rails_schema yamllint

```

With `eslint_npm` runner using locally installed eslint:

```yaml

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/[email protected]

        with:

          runners: eslint_npm # ...

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

### Development / Contributions

See [CONTRIBUTING.md](./CONTRIBUTING.md)