Skip to content

Commit

Permalink
add inputs docs to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Elfo404 committed Nov 5, 2024
1 parent 8ce7c61 commit 37563ee
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions actions/validate-policy-bot-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Validates the `.policy.yml` configuration file for [Policy Bot](https://github.com/palantir/policy-bot).
See [https://github.com/palantir/policy-bot?tab=readme-ov-file#configuration](Policy Bots' documentation) for more informations.

## Inputs

- `validation_endpoint`: The endpoint to validate the configuration against. Defaults to `https://policy-bot.grafana.net/api/v1/validate`.

Example workflow:

```yaml
Expand Down

0 comments on commit 37563ee

Please sign in to comment.