[402] adds checks to the pull request (#403)

* chanegs

* mistake

* mistake

* mistake

* changes

* doc

Author: tjhunter

.github/workflows/ci.yml

@@ -26,8 +26,24 @@ jobs:
       - name: Run ruff (black)
         # Do not attempt to install the default dependencies, this is much faster.
         # Run temporarily on a sub directory before the main restyling.
-        run: uv run --no-project --with "ruff==0.9.7" ruff format --target-version py312 --check -n src/
+        run: uv run --no-project --with "ruff==0.9.7" ruff format --target-version py312 --check -n src/ scripts/
 
       - name: Run ruff (flake8)
         # Do not attempt to install the default dependencies, this is much faster.
-        run: uv run --no-project --with "ruff==0.9.7" ruff check src/
+        run: uv run --no-project --with "ruff==0.9.7" ruff check src/ 
+  pr:
+    name: PR checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          # Install a specific version of uv.
+          version: "0.7.13"
+
+      - name: Check PR is linked to an issue
+      # Send the PR number to the script, which will check if it is linked to an issue.
+        run: scripts/check_gh_issue.py $GITHUB_REF_NAME

scripts/check_gh_issue.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env -S uv run
+# /// script
+# dependencies = [ "BeautifulSoup4", "requests"
+# ]
+# [tool.uv]
+# exclude-newer = "2025-01-01T00:00:00Z"
+# ///
+
+"""
+Checks that a pull request has a corresponding GitHub issue.
+
+Source:
+https://stackoverflow.com/questions/60717142/getting-linked-issues-and-projects-associated-with-a-pull-request-form-github-ap
+"""
+
+import requests
+from bs4 import BeautifulSoup
+import re
+
+repo = "ecmwf/WeatherGenerator"
+
+msg_template = """This pull request {pr} does not have a linked issue.
+Please link it to an issue in the repository {repo} before merging.
+The easiest way to do this is to add a comment with the issue number, like this:
+Fixes #1234
+This will automatically link the issue to the pull request.
+
+If you just want to reference an issue without closing it, you can use:
+Refs #1234
+
+See https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue
+"""
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser(description="Check GitHub PR for linked issues.")
+    parser.add_argument("pr", type=str, help="Pull request number")
+    args = parser.parse_args()
+
+    pr: str = args.pr
+    pr = pr.split("/")[0]
+    r = requests.get(f"https://github.com/{repo}/pull/{pr}")
+    soup = BeautifulSoup(r.text, "html.parser")
+    issueForm = soup.find_all("form", {"aria-label": re.compile("Link issues")})
+    msg = msg_template.format(pr=pr, repo=repo)
+
+    if not issueForm:
+        print(msg)
+        exit(1)
+    issues = [i["href"] for i in issueForm[0].find_all("a")]
+    issues = [i for i in issues if i is not None and repo in i]
+    print(f"Linked issues for PR {pr}:")
+    print(f"Found {len(issues)} linked issues.")
+    print("\n".join(issues))
+    if not issues:
+        print(msg)
+        exit(1)