mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-30 09:17:56 +00:00
Michael Kriese
f8ef935840
* fix(git): skip merge commits for semantic commit detection * docs: update docs
87 lines
3.0 KiB
Markdown
87 lines
3.0 KiB
Markdown
---
|
|
title: Semantic Commit messages
|
|
description: Configuring Renovate to use Semantic Commits
|
|
---
|
|
|
|
# Semantic Commit messages
|
|
|
|
Renovate looks at the last 20 commit messages in the base branch to decide if the repository uses semantic commits.
|
|
If there are Semantic Commits, Renovate uses an algorithm inspired by the [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) package to decide what convention the commit messages follow.
|
|
Merge commits are ignored when looking for semantic commits, so they do not affect the result.
|
|
|
|
Renovate can only find [conventional commits](https://www.conventionalcommits.org) style (including Angular-style conventional commits), it does not "understand" other commit conventions.
|
|
|
|
When Renovate finds conventional commits, Renovate creates commit messages and PR titles like this:
|
|
|
|
- chore(deps): update eslint to v7.30.0
|
|
|
|
By default, Renovate uses the `chore` prefix.
|
|
|
|
If you extend from `config:recommended` then Renovate uses the `chore` prefix for nearly all updates.
|
|
There are some exceptions:
|
|
|
|
- if the `depType` is a known "production dependency" type (e.g. `dependencies` or `require`), then Renovate uses the `fix` prefix
|
|
- if an update uses the `maven` datasource _and_ `matchDepTypes` is a known production type (e.g. `compile`, `provided`, `runtime`, `system`, `import` or `parent`) then Renovate uses the `fix` prefix
|
|
|
|
Be aware that the semantic commits feature does not work if you have a `commitMessagePrefix` configured - `commitMessagePrefix` will take priority.
|
|
|
|
## Manually enabling or disabling semantic commits
|
|
|
|
You can override the default settings, and disable or enable Semantic Commits.
|
|
|
|
```json title="If you want Renovate to use Semantic Commits"
|
|
{
|
|
"extends": [":semanticCommits"]
|
|
}
|
|
```
|
|
|
|
```json title="If you want Renovate to stop using Semantic Commits"
|
|
{
|
|
"extends": [":semanticCommitsDisabled"]
|
|
}
|
|
```
|
|
|
|
## Changing the Semantic Commit type
|
|
|
|
You can change the Semantic Commit type that Renovate uses.
|
|
For example:
|
|
|
|
- If you want Renovate to use the "chore" type for every PR, add `":semanticCommitTypeAll(chore)"` to your `extends` array:
|
|
|
|
```json
|
|
{
|
|
"extends": [":semanticCommitTypeAll(chore)"]
|
|
}
|
|
```
|
|
|
|
PR titles and commit messages start with `chore(deps):`.
|
|
|
|
- If you want Renovate to use the "ci" type for every PR, add `":semanticCommitTypeAll(ci)"` to your `extends` array:
|
|
|
|
```json
|
|
{
|
|
"extends": [":semanticCommitTypeAll(ci)"]
|
|
}
|
|
```
|
|
|
|
PR titles and commit messages start with `ci(deps):`.
|
|
|
|
## Changing the Semantic Commit scope
|
|
|
|
You can set your own word for the scope, if you do not like the default "deps" scope.
|
|
For example, to set the scope to "package", add the preset `":semanticCommitScope(package)"` to your `extends` array:
|
|
|
|
```json
|
|
{
|
|
"extends": [":semanticCommitScope(package)"]
|
|
}
|
|
```
|
|
|
|
To _remove_ the Semantic Commit scope, so Renovate uses `chore:` instead of `chore(deps):`, add the `":semanticCommitScopeDisabled"` preset to your `extends` array:
|
|
|
|
```json
|
|
{
|
|
"extends": [":semanticCommitScopeDisabled"]
|
|
}
|
|
```
|