32 lines
831 B
Markdown
32 lines
831 B
Markdown
# Check Conventional Commit Action
|
|
|
|
This Forgejo Action validates whether a given string complies with the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
|
|
|
|
## Usage
|
|
|
|
Include this action in your workflow and pass the value to be tested (e.g., a pull request title or a commit message) via the `value` input.
|
|
|
|
### Example Workflow
|
|
|
|
```yaml
|
|
name: PR Validation
|
|
on:
|
|
pull_request:
|
|
types:
|
|
- opened
|
|
- synchronize
|
|
- reopened
|
|
|
|
jobs:
|
|
check-pr-title:
|
|
runs-on: stackit-docker
|
|
steps:
|
|
- name: Validate PR Title
|
|
uses: https://stackit-solutions.git.onstackit.cloud/actions/check-conventional-commit@v1
|
|
with:
|
|
value: ${{ github.event.pull_request.title }}
|
|
```
|
|
|
|
## Inputs
|
|
|
|
- `value` (Required): The string (e.g., commit message) to be validated.
|