Skip to content

Improve automerge failure comments #87

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

Merged
mattleibow merged 1 commit into from
May 11, 2026
Merged

Improve automerge failure comments #87

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
41 changes: 35 additions & 6 deletions .github/workflows/automerge-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ jobs:
run: python3 .github/scripts/check-learn-build.py

- name: Merge PR
id: merge
if: |
steps.pr.outputs.found == 'true' &&
steps.check.outputs.should_merge == 'true' &&
Expand All @@ -98,10 +99,15 @@ jobs:
MERGE_SHA: ${{ steps.pr.outputs.head_sha }}
run: |
echo "Auto-merging PR #$PR_NUMBER (SHA: $MERGE_SHA)..."
gh pr merge "$PR_NUMBER" --squash \
merge_output=$(gh pr merge "$PR_NUMBER" --squash \
--match-head-commit "$MERGE_SHA" \
--subject "Update API docs from latest CI build" \
--body "Auto-merged after Learn Build validation passed (all checks green, no new warnings)."
--body "Auto-merged after Learn Build validation passed (all checks green, no new warnings)." 2>&1) || {
echo "merge_error<<EOF" >> "$GITHUB_OUTPUT"
echo "$merge_output" >> "$GITHUB_OUTPUT"
echo "EOF" >> "$GITHUB_OUTPUT"
exit 1
}

- name: Dry-run report
if: |
Expand All @@ -128,9 +134,32 @@ jobs:
env:
GH_TOKEN: ${{ github.token }}
PR_NUMBER: ${{ steps.pr.outputs.number }}
REASON: ${{ steps.check.outputs.reason }}
CHECK_REASON: ${{ steps.check.outputs.reason }}
NEW_WARNINGS: ${{ steps.check.outputs.new_warnings }}
MERGE_ERROR: ${{ steps.merge.outputs.merge_error }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
run: |
gh pr comment "$PR_NUMBER" --body \
"⚠️ **Auto-merge blocked**: ${REASON:-unknown failure}
body="⚠️ **Auto-merge blocked**"
body+="\n"

# Validation failure
if [ "$CHECK_REASON" != "All checks passed" ] && [ -n "$CHECK_REASON" ]; then
body+="\n**Validation**: $CHECK_REASON"
fi

# New warnings detail
if [ -n "$NEW_WARNINGS" ]; then
body+="\nUpdate \`.github/known-warnings.csv\` on \`main\` if these warnings are expected."
fi

# Merge failure (separate from validation)
if [ -n "$MERGE_ERROR" ]; then
body+="\n**Merge failed**: $MERGE_ERROR"
if echo "$MERGE_ERROR" | grep -q "not up to date"; then
body+="\nThe PR branch needs to be updated with \`main\` before it can be merged."
fi
fi

body+="\n\n[Workflow run]($RUN_URL)"

Review the [workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) for details. Update \`.github/known-warnings.csv\` on \`main\` if new warnings are expected."
printf "$body" | gh pr comment "$PR_NUMBER" --body-file -