Skip to content

Precise wording around dependabot auto-merge force option #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pofl wants to merge 2 commits into from
Closed

Precise wording around dependabot auto-merge force option #345

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a36c81a
Precise wording around dependabot auto-merge `force` option
pofl Jun 16, 2025
3879e4a
Update README.md
pofl Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,17 @@ In this section you can find examples of how to use template workflows. For more
### Auto-Merge Dependabot

<details>
<summary>The action can be used to auto-merge a dependabot PR with minor and patch updates.</summary>
<summary>The action can be used to auto-merge a dependabot PR.</summary>

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.
Copy link
Contributor

@flaxel flaxel Jun 16, 2025

Choose a reason for hiding this comment

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

The Satffbase Bot is not a generally usable bot by everyone. Therefore I wouldn't add it to the public repo. 😆

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.
Comment on lines +36 to +37
Copy link
Contributor

@flaxel flaxel Jun 16, 2025

Choose a reason for hiding this comment

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

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


⚠️ 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
Expand All @@ -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
Copy link
Contributor

@flaxel flaxel Jun 16, 2025

Choose a reason for hiding this comment

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

I would like to add another example as value because we don't need to add the default value. 😄

Suggested change
strategy: squash
strategy: rebase

# 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
Expand Down