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

fix: dependabot commit config #34149

Merged

Conversation

gagan-bhullar-tech
Copy link
Contributor

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).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@gagan-bhullar-tech gagan-bhullar-tech changed the title dependent commit config fix: dependabot commit config Jul 30, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 30, 2024
Copy link
Contributor

github-actions bot commented Jul 30, 2024

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Preview Production What Changed
code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

Copy link
Contributor

@janbrasna janbrasna left a 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:

- 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.)

gagan-bhullar-tech and others added 5 commits July 30, 2024 17:06
…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>
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team dependabot Content related to Dependabot code security Content related to code security waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jul 31, 2024
@nguyenalex836
Copy link
Contributor

@gagan-bhullar-tech Thank you for opening a PR! I'll get this triaged for review ✨

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Jul 31, 2024
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

Copy link
Contributor

@janbrasna janbrasna left a 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.)

@gagan-bhullar-tech
Copy link
Contributor Author

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.

@mchammer01 mchammer01 added needs SME This proposal needs review from a subject matter expert and removed needs SME This proposal needs review from a subject matter expert labels Aug 1, 2024
Copy link
Contributor

github-actions bot commented Aug 1, 2024

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

Copy link
Member

@jakecoffman jakecoffman left a 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

@mchammer01 mchammer01 self-requested a review August 1, 2024 14:51
Copy link
Contributor

@mchammer01 mchammer01 left a 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 ✨

@mchammer01 mchammer01 added this pull request to the merge queue Aug 1, 2024
Merged via the queue into github:main with commit 9587764 Aug 1, 2024
44 checks passed
Copy link
Contributor

github-actions bot commented Aug 1, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code security Content related to code security content This issue or pull request belongs to the Docs Content team dependabot Content related to Dependabot needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dependabot commit config include: "scope" output explainer
6 participants