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: describe known limitations #11946

Merged

Conversation

HonkingGoose
Copy link
Collaborator

Changes:

  • Describe Renovate's known limitations

Context:

We should set proper expectations with regards to Renovate bot's performance.
People like to imagine a super fast and powerful bot, that will do anything they can throw at it.
So we should explain what the bot can and cannot do for the user, and explain why we have some limitations.

Some things are a design decision, and other things are on our todo list.
For things that are on our todo list, we should mention issues that the reader can follow.

Inspired by discussion: #11884

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/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@HonkingGoose
Copy link
Collaborator Author

I know this is a really, really rough draft! I'm trying to feel out what we need to cover, and I don't know the ins and outs of the bot.... 😉

docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
docs/usage/known-limitations.md Outdated Show resolved Hide resolved
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok to start with this and improve it over time

@HonkingGoose
Copy link
Collaborator Author

Okay! I don't have anything meaningful to add anyways... 😄 😉

@rarkins rarkins enabled auto-merge (squash) October 1, 2021 07:23
@rarkins rarkins merged commit a7b34cf into renovatebot:main Oct 1, 2021
@HonkingGoose HonkingGoose deleted the docs/renovate-known-limitations branch October 1, 2021 08:31
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 27.25.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 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

3 participants