rainstormy/Validate commit messages in pull requests
Fails with a non-zero exit code if a commit message in a pull request is deemed invalid to remind developers to keep the commit history healthy by rebasing interactively before merging the pull request.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | The GitHub token that lets the action list the commits in the pull request. | yes | — |
| rules | A comma-separated list of the rules to enforce. | yes | — |
| acknowledged-author-email-addresses--patterns | A space-separated list of regular expressions for email addresses of commit authors to be accepted by `acknowledged-author-email-addresses`, e.g. `\d+\+.+@users\.noreply\.github\.com` for personal noreply email addresses on GitHub. | no | ^\b$ |
| acknowledged-author-names--patterns | A space-separated list of regular expressions for names of commit authors to be accepted by `acknowledged-author-names`, e.g. `\p{Lu}.*\s.+` for names that have at least two words where the first one starts with an uppercase letter. | no | ^\b$ |
| acknowledged-committer-email-addresses--patterns | A space-separated list of regular expressions for email addresses of committers to be accepted by `acknowledged-committer-email-addresses`, e.g. `\d+\+.+@users\.noreply\.github\.com` for personal noreply email addresses on GitHub. | no | ^\b$ |
| acknowledged-committer-names--patterns | A space-separated list of regular expressions for names of committers to be accepted by `acknowledged-committer-names`, e.g. `\p{Lu}.*\s.+` for names that have at least two words where the first one starts with an uppercase letter. | no | ^\b$ |
| imperative-subject-lines--whitelist | A comma-separated, case-insensitive list of additional words to be accepted by `imperative-subject-lines`. | no | — |
| issue-references-in-subject-lines--allowed-positions | A comma-separated list of positions where the issue reference is allowed to appear in the subject line to be enforced by `issue-reference-in-subject-lines`. Valid positions are `as-prefix` and `as-suffix`. | no | as-prefix,as-suffix |
| issue-references-in-subject-lines--patterns | A space-separated list of regular expressions for issue references to be accepted by `issue-reference-in-subject-lines`, e.g. `#[1-9][0-9]*` for GitHub issues or `ABC-[1-9][0-9]*` for Jira or YouTrack issues in a project named `ABC`. | no | ^\b$ |
| limit-length-of-body-lines--max-characters | A positive integer that specifies the maximum number of characters per line in the commit message body to be accepted by `limit-length-of-body-lines`. | no | 72 |
| limit-length-of-subject-lines--max-characters | A positive integer that specifies the maximum number of characters in the subject line to be accepted by `limit-length-of-subject-lines`. | no | 50 |
| no-squash-commits--disallowed-prefixes | A comma-separated, case-sensitive list of subject line prefixes to be rejected by `no-squash-commits`. | no | amend!,fixup!,squash! |
| no-trailing-punctuation-in-subject-lines--whitelist | A space-separated list of punctuation characters to be ignored by `no-trailing-punctuation-in-subject-lines`. | no | — |
Outputs
no outputs