Skip to main content

Module conventional

Module conventional 

Source
Expand description

Conventional-commit classification and semantic-version bump computation.

Subjects are matched against the Conventional Commits grammar (type(scope)!: description) on the first message line only. Breaking changes are detected from a ! marker in the subject or a BREAKING CHANGE / BREAKING-CHANGE footer at the start of a body line.

Structs§

ConventionalCommit

Enums§

BumpLevel
Strength of a semantic-version bump, ordered weakest to strongest.
CommitKind

Functions§

bump_version
Apply level to current, clearing any pre-release or build metadata.
classify_commits
Classify commits by their conventional-commit subject, skipping merge commits entirely.
release_notes
Render markdown release notes grouped by commit kind, listing breaking changes first and omitting empty sections.
required_bump
Determine the strongest bump the commits require, or None when no commit warrants a release.