Skip to content

Conversation

@DenverCoder1
Copy link
Contributor

@DenverCoder1 DenverCoder1 commented Sep 6, 2023

Why:

When I saw this example, I assumed this meant you could have groups defined outside of updates to apply to all package types. Doing so, however, causes the dependabot file check to fail with the following error:

Your .github/dependabot.yml contained invalid details

Dependabot encountered the following error when parsing your .github/dependabot.yml:

The property '#/' contains additional properties ["groups"] outside of the schema when none are allowed

Please update the config file to conform with Dependabot's specification.

Closes #27987

What's being changed (if available, include any code snippets, screenshots, or gifs):

This example shows groups at the top level of a dependabot.yml. This PR corrects it to have the groups indented within the npm updates settings since it otherwise fails.

# `dependabot.yml` file using the `update-types` option to group updates.
# Any packages matching the pattern @angular* where the highest resolvable
# version is minor or patch will be grouped together.
version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
groups:
  angular:
    patterns:
    - "@angular*"
    update-types:
    - "minor"
    - "patch"
# `dependabot.yml` file using the `update-types` option to group updates.
# Any packages matching the pattern @angular* where the highest resolvable
# version is minor or patch will be grouped together.
version: 2
updates:
  - package-ecosystem: "npm"
    directory: "/"
    schedule:
      interval: "weekly"
    groups:
      angular:
        patterns:
        - "@angular*"
        update-types:
        - "minor"
        - "patch"

Relevent docs links:

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

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

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 6, 2023
@cmwilson21
Copy link
Contributor

@DenverCoder1 Thanks so much for submitting a PR! I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 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 Sep 7, 2023
Copy link
Member

@jurre jurre left a comment

Choose a reason for hiding this comment

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

Thanks, that's totally right! 🙇

Copy link
Contributor

@am-stead am-stead left a comment

Choose a reason for hiding this comment

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

Thanks @DenverCoder1 for creating this PR and fixing this mistake! 🙏
I'll get this merged. ✨

@am-stead am-stead added this pull request to the merge queue Sep 8, 2023
Merged via the queue into github:main with commit 200d810 Sep 8, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 8, 2023

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

ALFA1OMEGA

This comment was marked as spam.

@ALFA1OMEGA

This comment was marked as spam.

@ALFA1OMEGA

This comment was marked as spam.

@DenverCoder1 DenverCoder1 deleted the dependabot-groups-fix branch September 11, 2023 23:29
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 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.

DOCS: Examples of groups parameter for Dependabot updates has wrong indentation level

5 participants