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

chore(Renovate): improve security posture of setup and other general improvements #22479

Merged
merged 5 commits into from Feb 3, 2024

Conversation

secustor
Copy link
Contributor

Hey, I just made a Pull Request!

These are some basic changes to your Renovate configuration, which I would recommend.
If you have questions or are not agreeing, to these changes, I can provide some input here.
It may be of interest that Renovate has currently 107 updates pending on this repository, so there is quite a backlog.

Changes:

  • add schema tag to give intellisense to all IDEs which support jsonschema
  • use config:best-practices instead of config:base which includes in turn config:recommended
    • enables DependencyDashboard
    • enables configMigration, which enables auto migration for not backwards compatible changes
    • pin Docker images and Github actions to digests for security purposes
    • tough the recommended pinning of dev dependencies is for now ignored
    • add community provided monorepo, grouping and replacement rules
  • increase PR limit to allow processing of more PRs by Collaborators/Maintainers in parallel.
    Consider the input in this guide. I'm happy to help you to improve your workflow here.

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

Signed-off-by: secustor <sebastian@poxhofer.at>
…d workarounds, as well dependency dashboard

Signed-off-by: secustor <sebastian@poxhofer.at>
Signed-off-by: secustor <sebastian@poxhofer.at>
Signed-off-by: secustor <sebastian@poxhofer.at>
@secustor secustor requested review from a team as code owners January 23, 2024 22:39
Copy link
Contributor

github-actions bot commented Jan 23, 2024

Uffizzi Cluster pr-22479 was deleted.

@freben
Copy link
Member

freben commented Jan 24, 2024

Hi! Thanks. I'll bring it up with the other maintainers. In the mean time, seems the config file isn't prettier formatted - try yarn prettier --write <file>.

Signed-off-by: secustor <sebastian@poxhofer.at>
labels: ['dependencies'],
extends: ['config:base', ':disableDependencyDashboard', ':gitSignOff'],
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is just more curiosity on my part but why do you recommend enabling the dependency dashboard? If you have some documentation on this I'm fine with you just pointing me that way 👍

Some background, I help support the Backstage Demo site (https://github.com/backstage/demo) and often help people on the Backstage Discord server. I'm slowly working on a tutorial with some guidance on using Renovate with Backstage.

Copy link
Contributor Author

@secustor secustor Jan 27, 2024

Choose a reason for hiding this comment

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

The dashboard is our main way to communicate with users. We show there ignored ( manually closed ) updates, rate limited ones ( because the concurrency limit has been reached ) and error. From there you can also can force a recreation of PRs.
https://docs.renovatebot.com/key-concepts/dashboard/

Looking forward to it! I'm working on a blog regarding Backstage and Renovate too.

See renovatebot/renovate#2958 as an example.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for the links! Do you have insights on using the Dependency Dashboard (which is basically a public issue) versus using the this - https://developer.mend.io/github/backstage/backstage - which does the same things but isn't public as best as I can tell. Also, for larger projects how do you handle that the issue can get lost in all the other issues? Do you just recommend pinning it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The developer portal is as far as I know also public, an exception are the logs of Renovate runs. Be aware that I have no insight how it functions in the background as this is part of Mends setup and not of the OSS project. Therefore could be that the portal does not show everything from the issue or vice versa.

Yes, we recommend pinning the issue, but it is also possible to give it a better searchable name or specific labels for better discovery.
https://docs.renovatebot.com/configuration-options/#dependencydashboardtitle
https://docs.renovatebot.com/configuration-options/#dependencydashboardlabels

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks again for the reply, appreciate it! 🚀

Copy link
Member

@Rugvip Rugvip left a comment

Choose a reason for hiding this comment

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

Thank you, I think it looks good! 👍

Happy about trying out the dashboard, we can always disable it if it doesn't work out.

Same thing with the increased concurrency limit. I think it makes sense because we often hit the point of too many blocked PRs to let more straight-forward bumps through.

@Rugvip Rugvip merged commit eb4298d into backstage:master Feb 3, 2024
29 checks passed
@secustor secustor deleted the ci/renovate-config branch February 19, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants