Skip to content

Commit f7e18b8

Browse files
authored
fix: options table formatting (#476)
1 parent 39bc6a5 commit f7e18b8

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,15 @@ jobs:
4444
4545
## Options
4646
47-
| Option | Required? | Type | Default Value | Description |
48-
| ------------------------------------------- | --------- | ------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
49-
| `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). |
50-
| `title-regex` | yes | string | ".\*" | A JavaScript regex to test the title of each Pull Request against. Allows anything by default. |
51-
| `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. |
52-
| `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`. |
53-
| `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. |
54-
| `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 |
55-
| reference regex. |
56-
| `on-succeeded-regex-dismiss-review-comment` | no | string | "All good!" | The message to post as a comment when the regex succeeds after previously failing. |
47+
| Option | Required? | Type | Default Value | Description |
48+
| ------------------------------------------- | --------- | ------ | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49+
| `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). |
50+
| `title-regex` | yes | string | ".\*" | A JavaScript regex to test the title of each Pull Request against. Allows anything by default. |
51+
| `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. |
52+
| `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`. |
53+
| `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. |
54+
| `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. |
55+
| `on-succeeded-regex-dismiss-review-comment` | no | string | "All good!" | The message to post as a comment when the regex succeeds after previously failing. |
5756

5857
## Changelog
5958

0 commit comments

Comments
 (0)