returntocorp/bento-action repository overview

⁠Bento Action

This GitHub Action reviews pull requests with Bento⁠ whenever a new commit is added to them. It reports as failed if there are any new bugs that first appeared in that pull request.

⁠Usage

To start checking all pull requests, add the following file at .github/workflows/bento.yml:

name: Bento
on: [pull_request]
jobs:
  bento:
    runs-on: ubuntu-latest
    name: Check
    steps:
    - uses: actions/checkout@v1
    - name: Bento
      id: bento
      uses: returntocorp/bento-action@v1
      with:
        acceptTermsWithEmail: <add your email here>

To use Bento, you must accept our Terms of Service & Privacy Policy⁠ by specifying your email address. This email will be used to provide support and share product updates — you can unsubscribe at any time.

⁠Configuration

⁠Blocking Pull Requests

The Bento Action reports a failure to GitHub if there are any new findings. This is marked with a red :x: indicator on pull requests and commits.

If you'd like to disallow merging pull requests when a Bento Action failure is present, or in other words, set up blocking, you can set this up on the Settings page of your repository, under Branches › Branch protection rules.

⁠Contributing

See CONTRIBUTING.md⁠