Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve stabilityDays documentation #9792

Merged
merged 2 commits into from Apr 30, 2021
Merged

docs: improve stabilityDays documentation #9792

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e4b047
docs: improve stabilityDays documentation
HonkingGoose Apr 30, 2021
d11b4ec
Apply suggestions from code review
HonkingGoose Apr 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/usage/configuration-options.md
View file
Open in desktop
Expand Up @@ -2166,11 +2166,16 @@ If this setting is true then you would get one PR for webpack@v2 and one for web

## stabilityDays

If this is configured to a non-zero value, and an update has a release date/timestamp available, then Renovate will check if the configured "stability days" have elapsed.
If the days since the release is less than the configured stability days then a "pending" status check will be added to the branch.
If enough days have passed then a passing status check will be added.
If this is set to a non-zero value, _and_ an update contains a release timestamp header, then Renovate will check if the "stability days" have passed.

There are a couple of uses for this:
If the amount of days since the release is less than the set `stabilityDays` 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.

Some datasources do not provide a release timestamp (in which case this feature is not compatible), and other datasources may provide a release timestamp but it's not supported by Renovate (in which case a feature request needs to be implemented).

Maven users: you cannot use `stabilityDays` if a Maven source returns unreliable `last-modified` headers.

There are a couple of uses for `stabilityDays`:

<!-- markdownlint-disable MD001 -->

Expand Down