A GitHub Action that automatically lints commit messages in pull requests using commitlint.
Commitlint GitHub Action is a GitHub Action that automatically validates commit messages in pull requests using commitlint. It enforces commit message conventions to ensure consistency and readability in a project's version history. The action integrates seamlessly into GitHub workflows and supports popular commit message standards like Conventional Commits.
Development teams using GitHub who want to automate commit message validation as part of their CI/CD pipeline. It's particularly useful for projects following structured commit conventions like Conventional Commits.
It provides a zero-configuration way to run commitlint in GitHub Actions, with built-in support for merge queues and extensible configuration. Unlike manual commitlint setups, it automatically lints all commits in pull requests and provides detailed, actionable feedback.
Lints Pull Request commits with commitlint
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Automatically lints all commits in pull requests, providing immediate feedback on message format before merging, as shown in the default workflow configuration.
Specifically designed to work with GitHub's merge queue feature, with detailed instructions for setup and configuration via the merge_group event.
Includes popular shared configs like conventional and angular, and allows custom plugins via the NODE_PATH environment variable, as demonstrated in the workflow example.
Provides both human-readable messages and structured JSON output, enabling integration with other workflow steps or custom reporting tools.
Only supports ES Module config files (.mjs), requiring migration from CommonJS (.js) files, which can be a hurdle for existing projects, as noted in the README.
Requires a placeholder workflow for pull_request events to trigger merge_group checks, adding complexity and potential confusion for users, as admitted in the setup instructions.
Tightly integrated with GitHub Actions and its ecosystem, making it unsuitable for projects on other CI/CD platforms or those considering migration away from GitHub.