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

docs(config options): nudge users away from commitMessage* (#18410)

parent 9439abe4
No related branches found
No related tags found
No related merge requests found
......@@ -390,26 +390,46 @@ This is used to alter `commitMessage` and `prTitle` without needing to copy/past
Actions may be like `Update`, `Pin`, `Roll back`, `Refresh`, etc.
Check out the default value for `commitMessage` to understand how this field is used.
<!-- prettier-ignore -->
!!! warning
Warning, for advanced use only! Use at your own risk!
## commitMessageExtra
This is used to alter `commitMessage` and `prTitle` without needing to copy/paste the whole string.
The "extra" is usually an identifier of the new version, e.g. "to v1.3.2" or "to tag 9.2".
<!-- prettier-ignore -->
!!! warning
Warning, for advanced use only! Use at your own risk!
## commitMessagePrefix
This is used to alter `commitMessage` and `prTitle` without needing to copy/paste the whole string.
The "prefix" is usually an automatically applied semantic commit prefix, but it can also be statically configured.
<!-- prettier-ignore -->
!!! warning
Warning, for advanced use only! Use at your own risk!
## commitMessageSuffix
This is used to add a suffix to commit messages.
Usually left empty except for internal use (multiple base branches, and vulnerability alerts).
<!-- prettier-ignore -->
!!! warning
Warning, for advanced use only! Use at your own risk!
## commitMessageTopic
This is used to alter `commitMessage` and `prTitle` without needing to copy/paste the whole string.
The "topic" is usually refers to the dependency being updated, e.g. `"dependency react"`.
<!-- prettier-ignore -->
!!! warning
Warning, for advanced use only! Use at your own risk!
## composerIgnorePlatformReqs
By default, Renovate will ignore Composer platform requirements as the PHP platform used by Renovate most probably won't match the required PHP environment of your project as configured in your `composer.json` file.
......
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