Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(semantic commits): capitalize Semantic Commits, style fixes #29720

Merged
merged 1 commit into from
Jun 17, 2024
Merged

docs(semantic commits): capitalize Semantic Commits, style fixes #29720

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/usage/semantic-commits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ description: Configuring Renovate to use Semantic Commits
# Semantic Commit messages

Renovate looks at the last 10 commit messages in the base branch to decide if the repository uses semantic commits.
If there are semantic commits, Renovate uses the [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) to decide what convention the commit messages follow.
If there are Semantic Commits, Renovate uses the [conventional-commits-detector](https://github.com/conventional-changelog/conventional-commits-detector) to decide what convention the commit messages follow.

Renovate only finds Angular-style conventional commits, it ignores other commit conventions.
Renovate can only find Angular-style conventional commits, it does not "understand" other commit conventions.

When Renovate finds Angular-style commits, Renovate creates commit messages and PR titles like this:

Expand All @@ -24,15 +24,15 @@ There are some exceptions:

## Manually enabling or disabling semantic commits

You can override the default settings, and disable or enable semantic commits.
You can override the default settings, and disable or enable Semantic Commits.

```json title="If you want Renovate to use 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"
```json title="If you want Renovate to stop using Semantic Commits"
{
"extends": [":semanticCommitsDisabled"]
}
Expand Down Expand Up @@ -65,7 +65,7 @@ For example:

## Changing the Semantic Commit scope

You can set your own word for the scope if you don't like the default "deps" 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
Expand All @@ -74,7 +74,7 @@ For example, to set the scope to "package", add the preset `":semanticCommitScop
}
```

To _remove_ the semantic commit scope, so Renovate uses `chore:` instead of `chore(deps):`, add the `":semanticCommitScopeDisabled"` preset to your `extends` array:
To _remove_ the Semantic Commit scope, so Renovate uses `chore:` instead of `chore(deps):`, add the `":semanticCommitScopeDisabled"` preset to your `extends` array:

```json
{
Expand Down