🎨 Force automerge as admin (#199)

* 🎨 Force automerge as admin

* 💄 Make linter happy

* 🚚 Rename admin variable to force

* 🎨 Change default type for force

* 📝 Add force documentation

* 📝 Add hint for prrotection rules

* 📝 Only run if the PR is created

* ⬇️ More explanation for force merge

.github/workflows/template_automerge_dependabot.yml

@@ -3,6 +3,11 @@ name: Dependabot Auto-Merge
 
 on:
   workflow_call:
+    inputs:
+      force:
+        default: false
+        required: false
+        type: boolean
     secrets:
       app_id:
         required: true
@@ -35,7 +40,12 @@ jobs:
         if: steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor'
         run: |
           gh pr review --approve "$PR_URL"
-          gh pr merge --auto --merge "$PR_URL"
+
+          if [ ${{ inputs.force }} == 'true' ]; then
+            gh pr merge "$PR_URL" --merge --admin
+          else
+            gh pr merge --auto --merge "$PR_URL"
+          fi
         env:
           PR_URL: ${{ github.event.pull_request.html_url }}
           GITHUB_TOKEN: ${{ steps.get_token.outputs.token }}

README.md

@@ -29,15 +29,24 @@ In this section you can find examples of how to use template workflows. For more
 <summary>The action can be used to auto-merge a dependabot PR with minor and patch updates.</summary>
 
 The action is called by creating a PR. It is necessary that the repository is enabled for auto-merge.
+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.
+If you want to enable the force merge, make sure that the app can bypass any protection rules.
 
 ```yml
 name: Enable Dependabot Auto-Merge
 
-on: pull_request
+on:
+  pull_request:
+    types: [opened]
 
 jobs:
   dependabot:
     uses: Staffbase/gha-workflows/.github/workflows/[email protected]
+    with:
+      # optional: ⚠️ only enable the force merge if you want to do the merge just now
+      force: true
     secrets:
       # identifier of the GitHub App for authentication
       app_id: ${{ <your-app-id> }}