cangulo-actions/🚔️ Commits Validation
Validate PR commits and calculate the next release version based on the changes. Commits must follow the conventional commit format `type(scope): description` Example: `feat(core): add new feature` Custom configuration is supported through a YML file.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit May 29, 2024
- License
- MIT
Pinned Snippet
uses: cangulo-actions/conventional-commits-validator@48853d4b9f88f3118a42cc9b161e855389001678 # 0.5.2tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| configuration | path to the YML configuration | no | "" |
| calculate-next-release | flag for calculating the next release. It will be printed as an annotation. | no | false |
| version-prefix | string to be added as prefix to the version. Only available if calculate-next-release is true. Example: v -> next-version: v1.0.0 | no | "" |
| label-pr-with-release-type | flag for adding the release type as a label to the PR. Format: 'release-type:<value>' Release Types: 'major', 'minor', 'patch', 'no-release' Example: 'release-type:major' | no | false |
| label-pr-with-commit-types | flag for adding each commit type as a label to the PR. Format: '<commit-type>' Commit Types: defined in 'commits.default' at ./config.schema.yml or in the inputs.configuration file Example: 'fix,docs' | no | false |
| label-pr-with-commit-scopes | flag for adding all scopes as labels to the PR. | no | false |
Outputs
| name | description |
|---|---|
| new-release-triggered | flag to detect if the PR changes will trigger a new release |
| next-version | version to be released when the PR is merged |
| next-release-type | next release type: major, minor or patch |
| changes | commits parsed into model: [{type, releaseAssociated, scopes, description, originalCommit}] |
| scopes | {scopename:{version,changes,changelog-record}} |