conventional-commits/conventionalcommits.org
Conventionalcommits.org
This project provides a specification for a structured commit message convention that enables automated semantic versioning and changelog generation. It defines a standard grammar for commit messages to ensure project history is readable by both humans and machines.
The specification maps specific commit types and breaking change indicators to version increment logic, allowing tools to automatically determine whether a patch, minor, or major release is required. This standardized format also facilitates the automatic production of human-readable release notes by parsing commit history.
The convention serves as a foundation for automation, providing a predictable metadata format that external tools use to trigger build, test, and deployment workflows within continuous integration pipelines.
Features
- Commit-Based Versioning Engines - Implements the core logic for determining semantic version increments by analyzing commit message types.
- Breaking Change Indicators - Uses specific tokens and modifiers to signal incompatible API changes, triggering major version increments.
- Commit Message Parsers - Establishes a grammar that allows tools to parse commit types and scopes using regular expressions.
- Commit History Analysis - Provides a specification for programmatically scanning and analyzing git commit logs to determine release scope.
- Commit Standards - Defines a rigid, standardized grammar for commit messages to ensure interoperability between automation tools.
- Release Changelog Generators - Defines a standard for transforming parsed commit metadata into structured, human-readable release notes.
- Breaking Change Detectors - Specifies tokens and footer keywords used to signal breaking changes for automated versioning.
- Change Intent Communication - Uses a consistent, structured format to signal the nature of changes to human stakeholders.
- Build Automation - Provides a predictable metadata format that allows external tools to automatically trigger build and publishing workflows.
- CI CD Pipelines - Facilitates the automatic initiation of build, test, and deployment workflows through standardized commit types.
- CI/CD Workflows - Provides a standardized message format used to signal and trigger specific build and deployment pipelines.
- Release Automation - Enables automated deployment pipelines to execute based on the nature and impact of changes identified in commits.
- CI/CD Integrations - Acts as a standardized integration point between developer commit history and CI/CD automation tools.
