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.

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

docs: improve stabilityDays config option documentation #10420

Merged
merged 3 commits into from Jun 14, 2021

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Jun 13, 2021

Changes:

  • Explain that stabilityDays only cares about the time since the release of that specific version not about whether the project as a whole has not released a new version in x days
  • Explain that you should set up a custom schedule for fast-releasing projects to slow down the barrage of PRs
  • Cover one usecase for stabilityDays: prevent holding broken npm packages (they can be unpublished with 72 hours)

Context:

Based on the confusion from a Renovate user on how stablityDays works.
See discussion #10419.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • No new tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@HonkingGoose HonkingGoose changed the title docs: explain stabilityDays not intended to slow down fast releases docs: improve stabilityDays config option documentation Jun 13, 2021
viceice
viceice previously approved these changes Jun 13, 2021
@HonkingGoose HonkingGoose marked this pull request as draft June 13, 2021 12:29
@HonkingGoose
Copy link
Collaborator Author

HonkingGoose commented Jun 13, 2021

Maybe it's better to put the npm usecase in its own section with its own heading. I've also added a configuration example to the npm usecase explanation.

@HonkingGoose HonkingGoose marked this pull request as ready for review June 13, 2021 13:04
@rarkins rarkins merged commit 720e6ed into renovatebot:main Jun 14, 2021
@HonkingGoose HonkingGoose deleted the docs/10419 branch June 14, 2021 11:36
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 25.41.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants