Enforce Conventional Commit Lint in CI
Add commitlint to a GitHub Actions workflow so non-conforming commit messages block the pull request before merge.
Task
Automate npx commitlint --from origin/main --to HEAD so pipeline failures are caught before merge and never reach production.
When to use this
A pull request merges with a broken npx commitlint --from origin/main --to HEAD step because the workflow did not gate on it, causing a failed deploy.
Prerequisites
- Node.js 22 and pnpm available
- A CI workflow file in .github/workflows
Steps
1. Configure npx commitlint --from origin/main --to HEAD in the project configuration file with the recommended defaults.
npx commitlint --from origin/main --to HEAD
Expected output: The configuration is accepted and npx commitlint --from origin/main --to HEAD runs without errors on the first invocation.
2. Run the check locally to verify npx commitlint --from origin/main --to HEAD produces the expected result before pushing.
act -j build # or: pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so npx commitlint --from origin/main --to HEAD blocks merge on failure.
- name: Run enforce conventional commit lint
run: pnpm test
Expected output: Pull requests with failing npx commitlint --from origin/main --to HEAD are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Gate the pipeline before merge
Start by measuring the problem. Add commitlint to a GitHub Actions workflow so non-conforming commit messages block the pull request before merge. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run npx commitlint –from origin/main –to HEAD against the current codebase and inspect the output before wiring it into CI.
npx commitlint --from origin/main --to HEADMake failures actionable
Once the gate is in place, make failures actionable. A failing npx commitlint –from origin/main –to HEAD should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.