Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
rarkins authored Oct 9, 2024
1 parent 084513f commit 9cf67ca
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/usage/config-migration.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# Config Migration

To improve the Renovate program, the Renovate maintainers often rename, remove or combine configuration options.
As part of continuous improvement and refinement, the Renovate maintainers often rename, remove or combine configuration options.

When the Renovate maintainers change configuration options, they add "config migration" code.
The migration code allows "legacy" config from users to keep working.
Config migration works by migrating legacy config internally, before the config is used.
If done right, config migration "just works" silently and legacy configs continue working indefinitely.
The only sign that "config migration" is needed is the debug message in the Renovate logs, noting the old and newly migrated configs.

By default, none of these changes are applied to Renovate config files (e.g. `renovate.json`)

## Enabling config migration pull requests

Even though Renovate allows you to keep using "legacy config", we recommend you update the configuration names in your config regularly.
Expand All @@ -19,10 +17,10 @@ Using the latest names:
- helps you find the documentation for the config

Renovate can create a config migration Pull Request, to migrate legacy config in your configuration file.
To get config migration pull requests from Renovate: set the [`configMigration`](./configuration-options.md#configmigration) config option to `true`.
To get automated config migration pull requests from Renovate: set the [`configMigration`](./configuration-options.md#configmigration) config option to `true`.

Config migration PRs are disabled by default.
But we _strongly_ recommend you enable config migration PRs, because:
But we recommend you enable config migration PRs, because:

- the config migration PR "tells" you something changed
- up-to-date terms help you search the Renovate documentation
Expand Down

0 comments on commit 9cf67ca

Please sign in to comment.