mridang/Commit Linter
GitHub Action that auto-installs commitlint configs/plugins, lints commits or the pull request title (configurable for squash-merge workflows) and posts a colored summary report.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token used to authenticate API requests. Required for fetching commit information. Use `secrets.GITHUB_TOKEN` or a PAT with appropriate permissions. | yes | — |
| commit-depth | The maximum number of commits to lint from the push. If empty, all commits in the event will be linted. | no | — |
| allow-force-install | If 'true', allows overwriting an existing package.json and forces npm to install dependencies using '--force' to resolve conflicting peer dependencies. Use with caution. | no | false |
| fail-on-warnings | If 'true', the action will fail if any linting warnings are found. Defaults to 'false'. | no | false |
| fail-on-errors | If 'false', the action will pass with a warning message even if linting errors are found. Defaults to 'true'. | no | true |
| help-url | A URL to display in linting error messages, pointing users to your commit message guidelines. | no | — |
| working-directory | The directory the action treats as the project root for resolving the commitlint configuration and any installed plugins. Defaults to the current process working directory (the repository root in a typical workflow). | no | — |
| lint-strategy | Which items to lint. 'commits' (default) lints each commit in the event. 'pr-title' lints only the pull request title, which is the message that lands in git history for squash-merge workflows. 'both' lints the PR title and every commit. When set to 'pr-title' on events without a pull request in the payload (e.g. push, merge_group), the action emits a workflow notice and exits successfully instead of failing, making it safe to combine with push triggers on your default branch. When using 'pr-title' on pull_request triggers, include 'edited' in the trigger's 'types' list so the action re-runs after a contributor fixes a bad title in the GitHub UI. | no | commits |
Outputs
no outputs