Skip to content

ci: Harmonize commit message format between commitlint and check-commits CI. #231

@nedseb

Description

@nedseb

Description

Two commit validation mechanisms coexist with slightly different formats:

commitlint (local git hook) — conventional commits format:

<type>(<scope>): <Description.>

Types: feat, fix, docs, style, refactor, test, ci, build, chore, perf, revert, tooling

check-commits.yml (CI) — legacy format:

<scope>: <Description.>

Pattern: ^[^!]+: [A-Za-z]+.+ .+\.$

Currently both accept the project's existing format (scope: Description.) because commitlint has subject-case: [0] and subject-full-stop: [0] disabled. But the conventional format (feat(scope): Description.) is not validated by the CI regex.

Tasks

  • Decide on a single format (conventional commits recommended)
  • Update check-commits.yml regex to accept conventional commits format
  • Or replace check-commits.yml with commitlint in CI (run npx commitlint --from origin/main in the workflow)
  • Update CONTRIBUTING.md if needed

Related

Metadata

Metadata

Assignees

Labels

ciCI/CD, workflows, lintingreleased

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions