roseline124/pr-title-convention
Fix PR title or comment when title is not matched with the Conventional Commits spec(https://www.conventionalcommits.org).
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| types | Provide custom types if you don't want the default ones from https://www.conventionalcommits.org | no | — |
| scopes | Configure which scopes are allowed. | no | — |
| subjectPattern | Configure additional validation for the subject based on a regex. E.g. '^(?!\s?[A-Z]).+$' the regex pattern ensures the subject doesn't start with an uppercase character. | no | — |
| subjectPatternError | If `subjectPattern` is configured, you can use this property to override the default error message that is shown when the pattern doesn't match. The variables `subject` and `title` can be used within the message. | no | — |
| wip | For work-in-progress PRs you can typically use draft pull requests from Github. However, private repositories on the free plan don't have this option and therefore this action allows you to opt-in to using the special '[WIP]' prefix to indicate this state. This will avoid the validation of the PR title and the pull request checks remain pending. Note that a second check will be reported if this is enabled. | no | — |
| validateSingleCommit | When using "Squash and merge" on a PR with only one commit, GitHub will suggest using that commit message instead of the PR title for the merge commit, and it's easy to commit this by mistake. Enable this option to also validate the commit message for one commit PRs. | no | — |
| action | The way to validate your pr title. default is 'comment' | no | — |
Outputs
no outputs