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

Add Dependency Dashboard showcase page #11178

Closed
HonkingGoose opened this issue Aug 9, 2021 · 7 comments · Fixed by #11183
Closed

Add Dependency Dashboard showcase page #11178

HonkingGoose opened this issue Aug 9, 2021 · 7 comments · Fixed by #11183
Assignees
Labels
core:dashboard Related to Dependency Dashboard functionality priority-2-high Bugs impacting wide number of users or very important features status:in-progress Someone is working on implementation type:docs Documentation

Comments

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Aug 9, 2021

What would you like Renovate to be able to do?

A user commented about our Dependency Dashboard:

Awesome feature. It should have a better exposure in the documentation maybe with a dedicated section in getting started.

I also think the dashboard is a great feature, and I agree that we should promote it better, and increase the discoverability of the feature.

We need this page to be there, before we can make "Dependency Dashboard enabled" the default behavior in v26.

Did you already have any implementation ideas?

It would probably go well under the Getting Started section of the sidebar, with a new entry "Dependency Dashboard".

I could write sections on:

  • Supported platforms
  • How to enable the dashboard
  • Use-cases:
    • Dependency Dashboard Approval workflow
    • Visibility into rejected/deferred updates
    • Other things that I'm not thinking of right now? Open for suggestions! 😉

Let me know if this is something you want me to work on. And if you have ideas on how to make it better, please share

@HonkingGoose HonkingGoose added type:feature Feature (new functionality) status:requirements Full requirements are not yet known, so implementation should not be started priority-5-triage labels Aug 9, 2021
@HonkingGoose HonkingGoose self-assigned this Aug 9, 2021
@HonkingGoose HonkingGoose added priority-2-high Bugs impacting wide number of users or very important features status:ready type:docs Documentation status:in-progress Someone is working on implementation and removed priority-5-triage status:requirements Full requirements are not yet known, so implementation should not be started type:feature Feature (new functionality) labels Aug 9, 2021
@HonkingGoose
Copy link
Collaborator Author

@rarkins Do you want me to target the main or v26 branch with a PR for this page?

@rarkins
Copy link
Collaborator

rarkins commented Aug 9, 2021

I think main is ok, thanks - as long as it doesn't say (yet) that it's enabled by default

@rowanbeentje
Copy link

Could there be anything around recommended usage? For example, one slight gotcha with the dependency dashboard for me is that there's no kind of notification possible when the dashboard is updated (see isaacs/github#310) - so I believe that with it enabled, the visibility of new PRs moves to an issue which developers need to manually check frequently to see if there are any warnings, errors, or dependencies that need updating.

@HonkingGoose
Copy link
Collaborator Author

Could there be anything around recommended usage? For example, one slight gotcha with the dependency dashboard for me is that there's no kind of notification possible when the dashboard is updated (see isaacs/github#310) - so I believe that with it enabled, the visibility of new PRs moves to an issue which developers need to manually check frequently to see if there are any warnings, errors, or dependencies that need updating.

That is the tradeoff when you enable "Dependency Dashboard approval" for specific updates/types of updates/all updates. For those updates you tell Renovate to shut up and wait for approval, you need to check yourself if there are any updates.

I don't think many people would benefit from telling Renovate to "go sit in a corner and wait quietly" though. The whole point of having a bot is that you're notified of updates when they happen... 😄

@HonkingGoose HonkingGoose added the core:dashboard Related to Dependency Dashboard functionality label Aug 9, 2021
@rarkins
Copy link
Collaborator

rarkins commented Aug 9, 2021

Yes, I think we should cover things, namely the threat of "out of sight, out of mind":

  • Dependency Dashboard Approval is far superior to disabling (e.g. for major updates) because at least you can fully see what's pending instead of it being invisible
  • Putting all on Approval is not recommended because many or most repo users won't ever look there regularly enough

@HonkingGoose
Copy link
Collaborator Author

Yes, I think we should cover things, namely the threat of "out of sight, out of mind":

* Dependency Dashboard Approval is far superior to disabling (e.g. for major updates) because at least you can fully see what's pending instead of it being invisible

* Putting all on Approval is not recommended because many or most repo users won't ever look there regularly enough

I've added your comments to the draft PR at #11183.

@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 25.75.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
core:dashboard Related to Dependency Dashboard functionality priority-2-high Bugs impacting wide number of users or very important features status:in-progress Someone is working on implementation type:docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants