Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 22 additions & 5 deletions .github/workflows/dependabot-auto-merge.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Dependabot auto-merge

# Queues auto-merge on Dependabot PRs. It approves nothing: the PR still needs
# a maintainer approval of the current head and every required check, and
# GitHub merges it only once both are satisfied.
# Queues auto-merge on classified minor/patch Dependabot PRs; approves nothing.
# A maintainer must still approve the current head and every required check must
# pass. GitHub merges only once the existing branch requirements are satisfied.
on:
pull_request:
types: [opened, reopened]
types: [opened, reopened, synchronize]
branches: [main]

permissions:
Expand All @@ -19,8 +19,25 @@ jobs:
contents: write
pull-requests: write
steps:
- name: Read verified Dependabot metadata
id: metadata
uses: dependabot/fetch-metadata@25dd0e34f4fe68f24cc83900b1fe3fe149efef98 # v3.1.0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Enable auto-merge
run: gh pr merge --auto --squash "$PR_URL"
shell: bash
run: |
# Check every dependency in a group; unknown types stay manual too.
if ! jq -e 'type == "array" and length > 0 and all(.[];
.updateType == "version-update:semver-minor" or
.updateType == "version-update:semver-patch")' \
<<< "$UPDATED_DEPENDENCIES" > /dev/null; then
echo "Leaving major or unclassified updates for manual handling."
exit 0
fi
gh pr merge --auto --squash --match-head-commit "$PR_HEAD_SHA" "$PR_URL"
env:
UPDATED_DEPENDENCIES: ${{ steps.metadata.outputs.updated-dependencies-json }}
PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
PR_URL: ${{ github.event.pull_request.html_url }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
128 changes: 128 additions & 0 deletions tests/test_dependabot_auto_merge.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
"""Exercise the real auto-merge shell without contacting GitHub."""

from __future__ import annotations

import json
import os
import re
import subprocess
import sys
import tempfile
import textwrap
import unittest
from pathlib import Path

WORKFLOW = (
Path(__file__).resolve().parents[1] / ".github/workflows/dependabot-auto-merge.yml"
)


class DependabotAutoMergeTests(unittest.TestCase):
@unittest.skipUnless(
sys.platform == "linux", "Matches the workflow's Ubuntu runner"
)
def test_metadata_eligibility(self):
patch = {"updateType": "version-update:semver-patch"}
minor = {"updateType": "version-update:semver-minor"}
major = {"updateType": "version-update:semver-major"}
cases = [
([patch], True),
([minor], True),
([major], False),
([minor, patch], True),
([patch, major], False),
([patch, {}], False),
([{"updateType": None}], False),
([{"updateType": "unknown"}], False),
([patch, "unknown"], False),
([], False),
(patch, False),
(None, False),
("not metadata", False),
]
for metadata, allowed in cases:
with self.subTest(metadata=metadata, allowed=allowed):
self._run_gate(json.dumps(metadata), allowed)

@unittest.skipUnless(
sys.platform == "linux", "Matches the workflow's Ubuntu runner"
)
def test_malformed_metadata_never_queues(self):
self._run_gate("{invalid", False)

def _run_gate(self, metadata, allowed):
# Keep this tooling dependency-free, as the existing workflow guards are.
block = re.search(
r"^ run: \|\n((?: [^\n]*\n)+)",
WORKFLOW.read_text(),
re.MULTILINE,
)
self.assertIsNotNone(block, "auto-merge must retain its literal Bash block")
script = textwrap.dedent(block[1])
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
output = root / "gh-args"
gh = root / "gh"
gh.write_text('#!/bin/sh\nprintf "%s\\n" "$@" > "$AUDIT_GH_ARGS"\n')
gh.chmod(0o755)
head = "a" * 40
url = "https://github.com/example/repo/pull/1"
env = {
**os.environ,
"PATH": str(root) + os.pathsep + os.environ["PATH"],
"AUDIT_GH_ARGS": str(output),
"UPDATED_DEPENDENCIES": metadata,
"PR_HEAD_SHA": head,
"PR_URL": url,
"GH_TOKEN": "unused-local-test-token",
}
subprocess.run(
["bash", "--noprofile", "--norc", "-e", "-o", "pipefail", "-c", script],
env=env,
check=True,
capture_output=True,
text=True,
timeout=10,
)
self.assertEqual(output.exists(), allowed)
if allowed:
self.assertEqual(
output.read_text().splitlines(),
[
"pr",
"merge",
"--auto",
"--squash",
"--match-head-commit",
head,
url,
],
)

def test_workflow_keeps_event_and_permission_boundaries(self):
source = WORKFLOW.read_text()
self.assertRegex(
source,
r"(?m)^on:\n pull_request:\n types: \[opened, reopened, synchronize\]\n"
r" branches: \[main\]\n\npermissions:",
)
for required in (
"user.login == 'dependabot[bot]'",
"head.repo.full_name == github.repository",
"permissions:\n contents: read\n",
" permissions:\n contents: write\n pull-requests: write\n",
"UPDATED_DEPENDENCIES: ${{ steps.metadata.outputs.updated-dependencies-json }}",
"PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }}",
"PR_URL: ${{ github.event.pull_request.html_url }}",
"GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}",
):
with self.subTest(required=required):
self.assertIn(required, source)
self.assertRegex(source, r"uses: dependabot/fetch-metadata@[0-9a-f]{40} #")
for forbidden in ("skip-verification", "skip-commit-verification", "checkout@"):
with self.subTest(forbidden=forbidden):
self.assertNotIn(forbidden, source)


if __name__ == "__main__":
unittest.main()
Loading