Warn to wait for checks if using Dependabot auto-merge
Dependabot auto-merge should be used in conjunction with a branch protection rule "Require status checks to pass before merging" for avoiding auto-merge by accident. When I adapted Dependabot auto-merge, I had been confused about instant auto-merge happening. I would have expected the action to wait for every check to pass (I assumed I didn't understand the dependabotautomerge.yml completely in the first place). Using "Require status checks to pass before merging" is the way to go - highlighting this in the documentation hopefully helps other developers using Dependabot auto-merge correctly in the first run.
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.
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/working-with-dependabot/automating-dependabot-with-github-actions.md |
fpt ghec ghes@ 3.7 3.6 3.5 3.4 3.3 ghae |
fpt ghec ghes@ 3.7 3.6 3.5 3.4 3.3 ghae |
fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE
@SchulteMarkus Thanks so much for opening a PR! I'll get this triaged for review :zap:
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:
I'll review this, have just asked someone from the Dependabot Updates team for help.
I'm going to apply my suggestions and check the preview. If all's well, we'll be happy to merge this pull request.
@SchulteMarkus - many thanks for contributing this improvement to the docs. This should save other developers from making this mistake.
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 :zap: