Update Dependabot options reference for clarity#40522
Update Dependabot options reference for clarity#40522Sharra-writes merged 3 commits intogithub:mainfrom
Conversation
Clarify behavior of 'increase-if-necessary' option in Dependabot.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies the description of the increase-if-necessary option in the Dependabot versioning strategy documentation to better explain its behavior with manifest and lockfile updates.
Key Changes:
- Expands the description of the
increase-if-necessaryversioning strategy option to clearly explain when Dependabot updates manifest files vs. lockfiles only
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
@cluse-heartflow Thanks for opening a PR! This wording definitely looks opaque as-is. I checked with the Dependabot team, and they proposed this wording to be more concise:
Do you think this is clearer, or is there a change you would like to make for better clarity? We're trying to keep it short since it appears in a table and we don't want a big block of text. That's unfortunately also a barrier to understanding. We could probably make it a little longer than this, though. |
|
Sure, sounds good to me. |
content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md
Outdated
Show resolved
Hide resolved
…dabot-options-reference.md
|
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Clarify behavior of 'increase-if-necessary' option in Dependabot.
Why:
Originally I misread this. I thought this setting would make Dependabot ignore minor versions. I didn't understand that with this setting enabled, Dependabot will still make a PR, but it will only update the lockfile, not the package.json.
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Just changing the description of the
increase-if-necessaryoption for Dependabot so that it is more obvious that this does not cause Dependabot to ignore minor versions.Check off the following: