Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix options table formatting #476

Merged
merged 1 commit into from
Jan 30, 2023
Merged

Fix options table formatting #476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
View file
Open in desktop
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