semantic-release uses the commit messages to determine the consumer impact of changes in the codebase.
Tools such as commitizen or commitlint are used to help contributors and enforce valid commit messages.
The table below shows which commit message corresponds to which release type when semantic-release runs:
| Commit message | Release type |
|---|---|
fix(pencil): stop graphite breaking when too much pressure applied |
|
feat(pencil): add 'graphiteWidth' option |
|
perf(pencil): remove graphiteWidth optionBREAKING CHANGE: The graphiteWidth option has been removed.The default graphite width of 10mm is always used for performance reasons. |
(Note that the BREAKING CHANGE: token must be in the footer of the commit) |
The commit message should follow the following format:
type(scope): subject
BLANK LINE
body
To simplify and automate the process of committing with this format, run git add and execute pnpm commit.