step-security/Conventional Commit In Pull Requests
Check that the PR title contains a valid task type and (optionally) a task number, and label the PR based on the task type
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| task_types | An array of task types. Example: ["feat","fix","docs","test","ci","refactor","perf","chore","revert"] | yes | — |
| scope_types | An array of valid scope types. If omitted, any scope is allowed. If given, include the empty scope with "". Example: ["login","signup","checkout","payment", ""] | no | — |
| title_regex | (optional) Regular expression for custom title validation; disabled by default. Example: 'PROJECT-\d{2,5}$' for trailing issue ticket, '"^[^:]+: [A-Z]"' for capitalized title | no | — |
| ticket_key_regex | ⚠️ DEPRECATED - Use "title_regex" instead. (optional) Regular expression for custom title validation; disabled by default. Example: 'PROJECT-\d{2,5}$' for trailing issue ticket, '"^[^:]+: [A-Z]"' for capitalized title | no | — |
| add_label | Whether to add labels | no | true |
| add_scope_label | Whether to add scope labels, such login for the title "fix(login): fix message in login page | no | false |
| token | GitHub token for applying labels. | no | ${{ github.token }} |
| custom_labels | A JSON string mapping task types to custom label names. Example: {"feat": "feature", "fix": "fix", "docs": "documentation", "test": "test", "ci": "CI/CD", "refactor": "refactor", "perf": "performance", "chore": "chore", "revert": "revert", "wip": "WIP"} | no | — |
Outputs
no outputs