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

Added note on renovate vs dependabot #7378

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/doc/developer/publishing/releasing-cd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ IMPORTANT: These files may have been set up this way by the https://github.com/j

=== Configure Dependabot

NOTE: If you have a `.github/renovate.json`, do not configure Dependabot. link:/blog/2023/09/20/renovate-bot-probe-blog[For more details]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
NOTE: If you have a `.github/renovate.json`, do not configure Dependabot. link:/blog/2023/09/20/renovate-bot-probe-blog[For more details]
NOTE: If you have a `.github/renovate.json`, do not configure Dependabot. Refer to the following blog post link:/blog/2023/09/20/renovate-bot-probe-blog[for more details].

Adjusting the text so that it is a full sentence with a full stop.

Copy link
Member

@timja timja Aug 22, 2024

Choose a reason for hiding this comment

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

I can't see how this blog post is related it should not be linked here.

Something like:

Suggested change
NOTE: If you have a `.github/renovate.json`, do not configure Dependabot. link:/blog/2023/09/20/renovate-bot-probe-blog[For more details]
NOTE: If you have link:https://docs.renovatebot.com/[Renovate] configured (normally in `renovate.json` or `.github/renovate.json`) do not configure Dependabot, as long as your renovate configuration isn't explicitly enabling a single manager Renovate will automatically start updating your new dependencies that are being added here.

or a shorter one:

Suggested change
NOTE: If you have a `.github/renovate.json`, do not configure Dependabot. link:/blog/2023/09/20/renovate-bot-probe-blog[For more details]
NOTE: If you have link:https://docs.renovatebot.com/[Renovate] configured (normally in `renovate.json` or `.github/renovate.json`) do not configure Dependabot.


If you have a `.github/dependabot.yml`, add:

[source,yaml]
Expand Down