Skip to content

fix: resolve dependabot auto-merge workflow issues #885

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

Open
MitaliBhalla wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −17
Open

fix: resolve dependabot auto-merge workflow issues #885

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 13 additions & 17 deletions .github/workflows/dependabot-auto-merge.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ permissions:
contents: write
pull-requests: write
checks: read
metadata: read
actions: read

jobs:
Expand All @@ -29,9 +28,11 @@ jobs:
- name: Check PR Labels
id: check-labels
run: |
# Check if PR has the required labels for auto-merge
if [[ "${{ contains(github.event.pull_request.labels.*.name, 'area/dependency') }}" == "true" ]] && \
[[ "${{ contains(github.event.pull_request.labels.*.name, 'ok-to-test') }}" == "true" ]]; then
# For Dependabot PRs, we'll be more permissive with labels
# Check if PR has dependency-related labels OR is from dependabot
if [[ "${{ contains(github.event.pull_request.labels.*.name, 'area/dependency') }}" == "true" ]] || \
[[ "${{ contains(github.event.pull_request.labels.*.name, 'dependencies') }}" == "true" ]] || \
[[ "${{ github.actor }}" == "dependabot[bot]" ]]; then
echo "has-required-labels=true" >> $GITHUB_OUTPUT
else
echo "has-required-labels=false" >> $GITHUB_OUTPUT
Expand All @@ -55,8 +56,8 @@ jobs:
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer $GH_TOKEN" \
"https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/merge" \
-d '{"merge_method":"merge"}')
"https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}" \
Copy link
Contributor

@xiaoyu74 xiaoyu74 Jan 28, 2026

Choose a reason for hiding this comment

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

Have you ever successfully used auto-merge for a PR before, but found it unstable or not working in certain scenarios?

Can see you use the GitHub REST API, I'm not sure whether auto-merge is actually supported. I found this discussion (https://github.com/orgs/community/discussions/24719
), and a recent reply in 2025 suggests it’s still unavailable?

-d '{"auto_merge":{"merge_method":"merge"}}')

if [[ "$response" -eq 200 ]]; then
echo "✅ Auto-merge enabled successfully"
Expand All @@ -82,17 +83,12 @@ jobs:
steps.check-labels.outputs.has-required-labels == 'true' &&
steps.metadata.outputs.update-type == 'version-update:semver-major'
run: |
gh pr comment "${{ github.event.pull_request.number }}" --body \
"🚨 **Major Version Update Detected** 🚨

This PR contains a major version update that requires manual review:
- **Dependency:** ${{ steps.metadata.outputs.dependency-names }}
- **Previous version:** ${{ steps.metadata.outputs.previous-version }}
- **New version:** ${{ steps.metadata.outputs.new-version }}

Please review the changelog and breaking changes before merging.

Auto-merge has been **disabled** for this PR."
# Add a comment to the PR explaining major version update (token is automatically masked)
curl -s -X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer $GH_TOKEN" \
"https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments" \
-d '{"body":"🚨 **Major Version Update Detected** 🚨\n\nThis PR contains a major version update that requires manual review:\n- **Dependency:** ${{ steps.metadata.outputs.dependency-names }}\n- **Previous version:** ${{ steps.metadata.outputs.previous-version }}\n- **New version:** ${{ steps.metadata.outputs.new-version }}\n\nPlease review the changelog and breaking changes before merging.\n\nAuto-merge has been **disabled** for this PR."}'
Copy link
Contributor

@xiaoyu74 xiaoyu74 Jan 28, 2026

Choose a reason for hiding this comment

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

If dependency name contains " or special characters, it can break JSON structure, may be better to use jq for better handle any JSON Escaping.

env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expand Down