-
Notifications
You must be signed in to change notification settings - Fork 59.7k
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
fix: dependabot commit config #34149
fix: dependabot commit config #34149
Conversation
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
...y/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The confusion comes from the example:
Lines 419 to 431 in 8898e15
- package-ecosystem: "pip" | |
directory: "/" | |
schedule: | |
interval: "weekly" | |
# Include a list of updated dependencies | |
# with a prefix determined by the dependency group | |
commit-message: | |
prefix: "pip prod" | |
prefix-development: "pip dev" | |
include: "scope" | |
``` | |
If you use the same configuration as in the example above, bumping the `requests` library in the `pip` development dependency group will generate a commit message of: |
where a) the scope is not being shown in the example below, b) is not supported by all managers in the ecosystem.
So it needs moving out of pip, and adding somewhere unambiguous. (Or, just removing L428, its demonstration is already present at Composer.)
...y/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md
Outdated
Show resolved
Hide resolved
...y/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md
Outdated
Show resolved
Hide resolved
…nfiguration-options-for-the-dependabot.yml-file.md Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
…nfiguration-options-for-the-dependabot.yml-file.md Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
…nfiguration-options-for-the-dependabot.yml-file.md Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
@gagan-bhullar-tech Thank you for opening a PR! I'll get this triaged for review ✨ |
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, thanks @gagan-bhullar-tech — this now reflects my experience. Let's just wait for the triage to xcheck the wording, but this now fixes the issue for me. The code example matches its description below w/ expected results, and the allow table looks reasonably valid.
(Note for reviewer: The removed scope in example didn't need to be moved elsewhere, as the Composer example right above it already demonstrates that.)
thanks @janbrasna for reviewing the PR. |
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reviewed for technical accuracy
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM from an editorial point of view 💖
Thank you @janbrasna for spotting the problem and the inaccuracies, and @gagan-bhullar-tech for fixing the docs ✨
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 ⚡ |
Why:
Closes: #33996
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
data
directory.For content changes, I have completed the self-review checklist.