[NDR-309] Add checkbox requirements to a PR (#877)

Author: jameslinnell

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+<!-- markdownlint-disable-next-line first-line-heading -->
+
+## Description
+
+<!-- Describe your changes in detail. -->
+
+## Context
+
+<!-- Why is this change required? What problem does it solve? -->
+
+## Checklist
+
+<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
+
+- [ ] I have followed the code style of the project.
+- [ ] I have added tests to cover my changes.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have considered the cross-team impact when creating this PR and where possible written tests to validate for all affected.
+- [ ] I have built a sandbox with code from this PR and ensured the unit tests and end-to-end tests have run successfully.
+- [ ] A member of all teams has approved this PR if there is a major code change. (If this is a minor change and you are confident this is not necessary then you may accept the standard approval process of 2 approvals from any teams.)
+
+---

.github/workflows/automated-pr-validator.yml

@@ -0,0 +1,29 @@
+name: "Z-AUTOMATED: PR Validator"
+
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, edited, synchronize]
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  checklist_validator:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.11
+
+      - name: Run checklist validator
+        run: |
+          python3 scripts/github/checklist_validator/main.py
+        env:
+          PR_BODY: ${{ github.event.pull_request.body }}

Makefile

@@ -83,7 +83,8 @@ test-bulk-upload-e2e:
 	cd ./lambdas && ./venv/bin/python3 -m pytest tests/e2e/bulk_upload -vv
 
 test-unit:
-	cd ./lambdas && ./venv/bin/python3 -m pytest tests/unit
+	cd ./lambdas && \
+	PYTHONPATH=.. ./venv/bin/python3 -m pytest tests/unit ../scripts/github/checklist_validator/tests
 
 test-unit-coverage:
 	cd ./lambdas && ./venv/bin/python3 -m pytest tests/unit --cov=. --cov-report xml:coverage.xml

scripts/github/checklist_validator/__init__.py

@@ -0,0 +1,30 @@
+def validate_checklist(body: str) -> bool:
+    """
+    Check if all PR checklist items are ticked.
+    Returns True if all boxes are checked, False otherwise.
+    """
+    if not body:
+        return False
+
+    lines = body.splitlines()
+    for line in lines:
+        line = line.strip()
+        if line.startswith("- [ ]"):
+            return False
+    return True
+
+
+def main():
+    import os
+
+    pr_body = os.environ.get("PR_BODY", "")
+    if validate_checklist(pr_body):
+        print("All checklist items are checked ✅")
+        exit(0)
+    else:
+        print("Some checklist items are not checked ❌")
+        exit(1)
+
+
+if __name__ == "__main__":
+    main()

scripts/github/checklist_validator/main.py

@@ -0,0 +1,22 @@
+import pytest
+from scripts.github.checklist_validator.main import validate_checklist
+
+
+def test_all_checked():
+    body = """
+- [x] Task 1
+- [x] Task 2
+"""
+    assert validate_checklist(body) is True
+
+
+def test_some_unchecked():
+    body = """
+- [x] Task 1
+- [ ] Task 2
+"""
+    assert validate_checklist(body) is False
+
+
+def test_empty_body():
+    assert validate_checklist("") is False