Update dependabot.yml file naming information to include the .yaml extension#43123
Update dependabot.yml file naming information to include the .yaml extension#43123DanGM96 wants to merge 1 commit intogithub:mainfrom
Conversation
Clarified that the dependabot configuration file can be named dependabot.yaml in addition to dependabot.yml. References: - dependabot/feedback#874 - https://github.com/yaml/go-yaml/blob/main/.github/dependabot.yaml
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. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Dependabot configuration documentation to explicitly note that the config file may use the .yaml extension (in addition to .yml), aligning the docs with real-world behavior.
Changes:
- Update the documented config file path to mention
.github/dependabot.yamlas an accepted alternative to.github/dependabot.yml.
| ## Where to store the `dependabot.yml` file | ||
|
|
||
| You must store this file in the `.github` directory of your repository in the default branch (typically `main`). The path is: `.github/dependabot.yml`. | ||
| You must store this file in the `.github` directory of your repository in the default branch (typically `main`). The path is: `.github/dependabot.yml` (you can also use `.github/dependabot.yaml`). |
There was a problem hiding this comment.
There are two spaces after the colon in "The path is: .github/dependabot.yml", which looks like an editing artifact and can trip content linting/formatting. Consider tightening the sentence (for example, avoid the colon/parenthetical) and use a single space.
| You must store this file in the `.github` directory of your repository in the default branch (typically `main`). The path is: `.github/dependabot.yml` (you can also use `.github/dependabot.yaml`). | |
| You must store this file in the `.github` directory of your repository in the default branch (typically `main`), at `.github/dependabot.yml` or `.github/dependabot.yaml`. |
There was a problem hiding this comment.
I have no strong feelings about this change and the double spaces were already there. A maintainer can commit the suggestion if they agree with the bot.
Clarified that the dependabot configuration file can be named dependabot.yaml in addition to dependabot.yml.
References:
Why:
In practice this has been possible for many years and the documentation does not reflect it.
Resulting in AI chats such as Copilot denying the possibility of using the .yaml extension.
What's being changed:
Just a minor part of the documentation, although it could be more explicit and added in other places, it should allow for Search Engines and AI Bots to reach the information.
Check off the following: