Skip to content
Snippets Groups Projects
Unverified Commit 7f5c4507 authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

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

parent 03c034fb
No related branches found
No related tags found
No related merge requests found
...@@ -6,9 +6,9 @@ description: Configuring Renovate to use Semantic Commits ...@@ -6,9 +6,9 @@ description: Configuring Renovate to use Semantic Commits
# Semantic Commit messages # Semantic Commit messages
Renovate looks at the last 10 commit messages in the base branch to decide if the repository uses semantic commits. 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: When Renovate finds Angular-style commits, Renovate creates commit messages and PR titles like this:
...@@ -24,15 +24,15 @@ There are some exceptions: ...@@ -24,15 +24,15 @@ There are some exceptions:
## Manually enabling or disabling semantic commits ## 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"] "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"] "extends": [":semanticCommitsDisabled"]
} }
...@@ -65,7 +65,7 @@ For example: ...@@ -65,7 +65,7 @@ For example:
## Changing the Semantic Commit scope ## 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: For example, to set the scope to "package", add the preset `":semanticCommitScope(package)"` to your `extends` array:
```json ```json
...@@ -74,7 +74,7 @@ For example, to set the scope to "package", add the preset `":semanticCommitScop ...@@ -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 ```json
{ {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment