diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 21afd700a7a7a0..106f469b387adb 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -2274,38 +2274,41 @@ Renovate will only add a milestone when it _creates_ the PR. This feature used to be called `stabilityDays`. -If this is set _and_ an update has a release timestamp header, then Renovate will check if the set duration has passed. +If `minimumReleaseAge` is set to a time duration _and_ the update has a release timestamp header, then Renovate will check if the set duration has passed. Note: Renovate will wait for the set duration to pass for each **separate** version. Renovate does not wait until the package has seen no releases for x time-duration(`minimumReleaseAge`). -`minimumReleaseAge` is not intended to help with slowing down fast releasing project updates. -If you want to slow down PRs for a specific package, setup a custom schedule for that package. -Read [our selective-scheduling help](./noise-reduction.md#selective-scheduling) to learn how to set the schedule. -If the time since the release is less than the set `minimumReleaseAge` a "pending" status check is added to the branch. -If enough days have passed then the "pending" status is removed, and a "passing" status check is added. +Do _not_ use `minimumReleaseAge` to slow down fast releasing project updates. +Instead setup a custom `schedule` for that package, read [our selective-scheduling help](./noise-reduction.md#selective-scheduling) to learn how. -Some datasources don't have a release timestamp, in which case this feature is not compatible. -Other datasources may have a release timestamp, but Renovate does not support it yet, in which case a feature request needs to be implemented. +When the time passed since the release is _less_ than the set `minimumReleaseAge`: Renovate adds a "pending" status check to that update's branch. +After enough days have passed: Renovate replaces the "pending" status with a "passing" status check. -Maven users: you cannot use `minimumReleaseAge` if a Maven source returns unreliable `last-modified` headers. +The datasource that Renovate uses must have a release timestamp for the `minimumReleaseAge` config option to work. +Some datasources may have a release timestamp, but in a format that's Renovate does not support. +In those cases a feature request needs to be implemented. + + +!!! warning "Warning for Maven users" + For `minimumReleaseAge` to work, the Maven source must return reliable `last-modified` headers. !!! note Configuring this option will add a `renovate/stability-days` option to the status checks. -There are a couple of uses for `minimumReleaseAge`: +Examples of how you can use `minimumReleaseAge`: #### Suppress branch/PR creation for X days -If you combine `minimumReleaseAge=3 days` and `internalChecksFilter="strict"` then Renovate will hold back from creating branches until 3 or more days have elapsed since the version was released. -We recommend that you set `dependencyDashboard=true` so you can see these pending PRs. +If you use `minimumReleaseAge=3 days` and `internalChecksFilter="strict"` then Renovate only creates branches when 3 (or more days) have passed since the version was released. +We recommend you set `dependencyDashboard=true`, so you can see these pending PRs. #### Prevent holding broken npm packages -npm packages less than 72 hours (3 days) old can be unpublished, which could result in a service impact if you have already updated to it. +npm packages less than 72 hours (3 days) old can be unpublished from the npm registry, which could result in a service impact if you have already updated to it. Set `minimumReleaseAge` to `3 days` for npm packages to prevent relying on a package that can be removed from the registry: ```json @@ -2321,8 +2324,10 @@ Set `minimumReleaseAge` to `3 days` for npm packages to prevent relying on a pac #### Await X time duration before Automerging -If you enabled `automerge` _and_ `minimumReleaseAge`, it means that PRs will be created immediately but automerging will be delayed until the time-duration has passed. -This works because Renovate will add a "renovate/stability-days" pending status check to each branch/PR and that pending check will prevent the branch going green to automerge. +If you enable `automerge` _and_ `minimumReleaseAge`, Renovate will create PRs immediately, but only automerge them when the `minimumReleaseAge` time-duration has passed. + +Renovate adds a "renovate/stability-days" pending status check to each branch/PR. +This pending check prevents the branch going green to automerge before the time has passed.