neofinancial/Pull Request Ticket Check Action
Verify that pull request titles start with a ticket ID
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| ticketPrefix | The unique identifier for the ticket/issue | no | "" |
| titleFormat | The intended format the title should be set to if it doesn't match the regular expression. Available variables are `%prefix%`, `%id%`, and `%title%` | yes | %prefix%%id%: %title% |
| titleRegex | The regular expression used to search the title for the intended format | yes | ^(CH)(-?)(?<ticketNumber>\d{3,}) |
| titleRegexFlags | The regular expression flags applied to the title regular expression | yes | gi |
| branchRegex | The regular expression used to search the branch for the intended format | yes | ^(CH)(-?)(?<ticketNumber>\d{3,}) |
| branchRegexFlags | The regular expression flags applied to the branch regular expression | yes | gi |
| bodyRegex | The regular expression used to search the body for a shorthand reference | yes | (CH)(-?)(?<ticketNumber>\d{3,}) |
| bodyRegexFlags | The flags applied to the body regular expression when searching for a shorthand reference | yes | gim |
| bodyURLRegex | The regular expression used to search the body for a URL reference | no | — |
| bodyURLRegexFlags | The flags applied to the body regular expression when searching for a URL reference | yes | gim |
| exemptUsers | User(s) who will be exempt from the ticket check rules. Particularly useful for automated/bot PRs | no | "" |
| quiet | Suppress comment on successful PR title update | no | true |
| token | GitHub authentication token | yes | — |
| ticketLink | Ticket URL with `%ticketNumber%` placeholder | no | — |
Outputs
no outputs