diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 4b4328cd6b7ebfafc3f459fac5a5053dd591942a..44fcb716a718cd0daf7d6163eb1f2bee51c2c88d 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -478,12 +478,13 @@ If enabled, all issues created by Renovate are set as confidential, even in a pu ## configMigration -If enabled, Renovate will raise a pull request if config file migration is needed. +If enabled, Renovate raises a pull request when it needs to migrate the Renovate config file. +Renovate only performs `configMigration` on `.json` and `.json5` files. We're adding new features to Renovate bot often. -Most times you can keep using your Renovate config and benefit from the new features right away. -But sometimes you need to change your Renovate configuration. -To help you with this, Renovate will create config migration pull requests. +Often you can keep using your Renovate config and benefit from the new features right away. +But sometimes you need to update your Renovate configuration. +To help you with this, Renovate will create config migration pull requests, when you enable `configMigration`. Example: @@ -497,13 +498,17 @@ After we changed the [`baseBranches`](https://docs.renovatebot.com/configuration ``` <!-- prettier-ignore --> -!!! info - This feature writes plain JSON for `.json` files, and JSON5 for `.json5` files. - JSON5 content can potentially be down leveled (`.json` files) and all comments will be removed. +!!! caution + The `configMigration` feature writes plain JSON for `.json` files, and JSON5 for `.json5` files. + Renovate may downgrade JSON5 content to plain JSON. + When downgrading JSON5 to JSON Renovate may also remove the JSON5 comments. + This can happen because Renovate wrongly converts JSON5 to JSON, thus removing the comments. <!-- prettier-ignore --> !!! note - Closing the config migration PR will cause it to be ignored and not being reopend/recreated in the future.', + When you close a config migration PR, Renovate ignores it forever. + This also means that Renovate won't create a config migration PR in future. + If you closed the PR by accident, find the closed PR and re-name the PR title to get a new PR. ## configWarningReuseIssue