Skip to content

Commit

Permalink
explain
Browse files Browse the repository at this point in the history
  • Loading branch information
@morgante
morgante committed Dec 18, 2023
1 parent c1ba5f9 commit ded8b58
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This action runs the Grit CLI to report any violations of your configured [Grit patterns](https://docs.grit.io/guides/config).

This action will add annotations to the GitHub commit or pull request with any `warning` or `error` patterns that are matched. If any `error` patterns are matched, the action will fail the workflow (exit code 1).

## Usage

You can add it as a step in your GitHub Actions workflow to automatically check for violations on every push:
Expand Down

0 comments on commit ded8b58

Please sign in to comment.