Precise wording around dependabot auto-merge force option#345
Precise wording around dependabot auto-merge force option#345
force option#345Conversation
pofl
added
the
documentation
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
There was a problem hiding this comment.
Pull Request Overview
This PR refines the phrasing around Dependabot auto-merge, clarifies the force option, and updates example comments for strategy and update types.
- Updated
<summary>and description to generalize auto-merge trigger. - Clarified
forcebehavior and required permissions. - Improved YAML example comments for strategy and update-types.
Comments suppressed due to low confidence (2)
README.md:39
- [nitpick] This warning is redundant with the previous sentence about force merge—consider removing or consolidating one of them to avoid duplication.
⚠️ You can also force a merge of a PR. This means that the PR will be merged immediately.
README.md:57
- [nitpick] For consistency and readability, add a space after the comma in 'Default: minor,patch' (i.e., 'minor, patch').
# optional: comma-separated list of updates to handle (Available types: major, minor, patch. Default: minor,patch)
| strategy: rebase, merge | ||
| # optional: choose which types of update you want to allow (default: minor,patch) | ||
| # optional: choose strategy when merging (Accepted values: rebase, merge, squash. Default: squash) | ||
| strategy: squash |
There was a problem hiding this comment.
I would like to add another example as value because we don't need to add the default value. 😄
| strategy: squash | |
| strategy: rebase |
| Option `force` can be used to merge the PR right away instead of only enabling auto-merge. The bot needs to have | ||
| protection rule bypass permissions for that to work. |
There was a problem hiding this comment.
Which extra information you are getting with the comment? The bypass rights are mentioned right after this comment and the function of the option is described in the workflow example. 👀
|
|
||
| The action is called by creating a PR. It is necessary that the repository is enabled for auto-merge. | ||
| This workflow triggers when dependabot creates a PR. It will use the | ||
| [staffbase bot](https://github.com/apps/staffbase-actions) to approve the PR and to enable auto-merge. |
There was a problem hiding this comment.
The Satffbase Bot is not a generally usable bot by everyone. Therefore I wouldn't add it to the public repo. 😆
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
No activity here, I will close that PR now |
Type of Change
Description
Precise wording around dependabot auto-merge
forceoptionChecklist