Skip to content

Commit

Permalink
doc: config-path input
Browse files Browse the repository at this point in the history
  • Loading branch information
jamacku committed Nov 9, 2023
1 parent 00f2664 commit cb8a3f9
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,9 @@ Action currently accepts the following options:
- uses: redhat-plumbers-in-action/devel-freezer@v1
with:
pr-number: <number>
token: <GitHub token>
pr-number: <number>
config-path: <path to config file>
token: <GitHub token>
# ...
```
Expand All @@ -213,6 +214,13 @@ Pull Request number.
* default value: `${{ github.event.number }}`
* requirements: `required`

### config-path

Path to configuration file. Configuration file format is described in: [Policy section](#policy).

* default value: `.github/development-freeze.yml`
* requirements: `optional`

### token

Token used to create comments. Minimal required permissions are `contents: read` and `pull-requests: write`
Expand Down Expand Up @@ -263,4 +271,4 @@ The message that is going to be displayed in form of a comment when development

The message that is going to replace the development freeze message when development freeze conditions are no longer met. Support for a multi-line string using `|` YAML syntax.

* requirements: `required`
* requirements: `required`

0 comments on commit cb8a3f9

Please sign in to comment.