This github actions checks if a pull request has valid commits by using commitlint
- it can check the title of the PR
- it can check all commits of the PR
- it will comment on the PR if invalid messages are found. (optional)
name: "Check for semantic PR"
on:
pull_request:
types:
- opened
- edited
- synchronize
jobs:
main:
runs-on: ubuntu-latest
steps:
- uses: paschdan/semantic-pullrequest-action@v1
Personal access token (PAT) used to interact with the GitHub API. By default, the automatic token provided by GitHub is used. You can see more info about GitHub's default token here.
default: ${{ github.token }}
A URL that is shown when commits are not valid, to get help
default: https://www.conventionalcommits.org/en/v1.0.0/
The commitlint config file to use for linting
Should commitlint output also valid commits
if set to anything the action will comment on the pr with the results.
if set to false, will skip checking the pr title
default: true
if set to false, will skip checking the commits
default: true