Skip to content

livery.workshop._conventional

livery.workshop._conventional

The commit convention: the grammar every title is held to.

A pull request title (and so, on a squash-only main, every commit subject) is type(scope): subject, with ! before the colon or a BREAKING CHANGE: footer marking a break. The submit verb enforces it here.

Two readers take the convention back. livery.workshop._versions derives a package's next version from it, and the release notes' provider, when an extension registers one, writes the entry the commits earn from it.

Attributes:

Name Type Description
TYPES
TITLE_RE

TYPES module-attribute

TYPES = ('feat', 'fix', 'docs', 'chore', 'refactor', 'test')

TITLE_RE module-attribute

TITLE_RE = re.compile(f"^({'|'.join(TYPES)})(\\([^)]+\\))?(!)?: .+$")