From a36c81a5190158c39770060693000c88f48067a3 Mon Sep 17 00:00:00 2001 From: Florian Polster Date: Mon, 16 Jun 2025 15:12:13 +0200 Subject: [PATCH 1/2] Precise wording around dependabot auto-merge `force` option --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b32c8786..27003277 100644 --- a/README.md +++ b/README.md @@ -26,12 +26,17 @@ In this section you can find examples of how to use template workflows. For more ### Auto-Merge Dependabot
-The action can be used to auto-merge a dependabot PR with minor and patch updates. +The action can be used to auto-merge a dependabot PR. -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. +Auto-merge need to be enabled on the repo for this to work. Afterward the PR will be merged with the help of the merge queue if all required conditions of the repository are fulfilled. -⚠️ You can also force a merge of a PR. This means that the PR will immediately be merged. +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. + +⚠️ You can also force a merge of a PR. This means that the PR will be merged immediately. If you want to enable the force merge, make sure that the app can bypass any protection rules. ```yml @@ -45,11 +50,11 @@ jobs: dependabot: uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v7.9.0 with: - # optional: ⚠️ only enable the force merge if you want to do the merge just now + # optional: ⚠️ the merge will be performed immediately instead of just activating auto-merge force: true - # optional: choose strategy when merging (default: squash) - 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 + # optional: comma-separated list of updates to handle (Available types: major, minor, patch. Default: minor,patch) update-types: major,minor,patch # optional: choose if you want to allow versions with semver 0.X.X (default: false) include-pre-release: true From 3879e4a7dd37504af048015301032d9049a5b0d1 Mon Sep 17 00:00:00 2001 From: Florian Polster Date: Mon, 16 Jun 2025 16:05:19 +0200 Subject: [PATCH 2/2] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 27003277..3795bd51 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ In this section you can find examples of how to use template workflows. For more 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. -Auto-merge need to be enabled on the repo for this to work. +Auto-merge needs to be enabled on the repo for this to work. Afterward the PR will be merged with the help of the merge queue if all required conditions of the repository are fulfilled. Option `force` can be used to merge the PR right away instead of only enabling auto-merge. The bot needs to have