Skip to content

Commit

Permalink
fix: options table formatting (#476)
Browse files Browse the repository at this point in the history
  • Loading branch information
@devnev
devnev authored Jan 30, 2023
1 parent 39bc6a5 commit f7e18b8
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,15 @@ jobs:
## Options
| Option | Required? | Type | Default Value | Description |
| ------------------------------------------- | --------- | ------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `repo-token` | yes | string | N/A | [About the `GITHUB_TOKEN` secret](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret). |
| `title-regex` | yes | string | ".\*" | A JavaScript regex to test the title of each Pull Request against. Allows anything by default. |
| `on-failed-regex-fail-action` | no | bool | true | If the regex fails, sets the action status to failed. When the action exits it will be with an exit code of 1. |
| `on-failed-regex-create-review` | no | bool | true | If the regex fails, uses the GitHub review mechanism to submit a review. The review type is determined by `on-failed-regex-request-changes`. |
| `on-failed-regex-request-changes` | no | bool | true | Uses 'Request Changes' when creating a review. Otherwise, uses 'Comment'. _Note:_ if `on-failed-regex-create-review` is `false`, this won't do anything. |
| `on-failed-regex-comment` | no | string | "PR title failed to match %regex%" | Comment for the bot to post on PRs that fail the regex (or the console output if `on-failed-regex-create-review` is `false`). Use %regex% to |
| reference regex. |
| `on-succeeded-regex-dismiss-review-comment` | no | string | "All good!" | The message to post as a comment when the regex succeeds after previously failing. |
| Option | Required? | Type | Default Value | Description |
| ------------------------------------------- | --------- | ------ | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `repo-token` | yes | string | N/A | [About the `GITHUB_TOKEN` secret](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret). |
| `title-regex` | yes | string | ".\*" | A JavaScript regex to test the title of each Pull Request against. Allows anything by default. |
| `on-failed-regex-fail-action` | no | bool | true | If the regex fails, sets the action status to failed. When the action exits it will be with an exit code of 1. |
| `on-failed-regex-create-review` | no | bool | true | If the regex fails, uses the GitHub review mechanism to submit a review. The review type is determined by `on-failed-regex-request-changes`. |
| `on-failed-regex-request-changes` | no | bool | true | Uses 'Request Changes' when creating a review. Otherwise, uses 'Comment'. _Note:_ if `on-failed-regex-create-review` is `false`, this won't do anything. |
| `on-failed-regex-comment` | no | string | "PR title failed to match %regex%" | Comment for the bot to post on PRs that fail the regex (or the console output if `on-failed-regex-create-review` is `false`). Use %regex% to reference regex. |
| `on-succeeded-regex-dismiss-review-comment` | no | string | "All good!" | The message to post as a comment when the regex succeeds after previously failing. |

## Changelog

Expand Down

0 comments on commit f7e18b8

Please sign in to comment.