Merge pull request #21 from alyssacgoins/gatekeeper-workflow

Issue triage workflow.

Author: alyssacgoins

.github/scripts/verify-pr-ready.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+import os
+import re
+import sys
+
+from github import Auth, Github
+
+def clean_pr_body(body: str) -> str:
+    if not body:
+        return ""
+    clean_text = re.sub(r'<!--.*?-->', '', body, flags=re.DOTALL)
+    return clean_text.strip()
+
+
+def main() -> int:
+    token = os.getenv("GITHUB_TOKEN")
+    pr_num = int(os.getenv("PR_NUMBER"))
+    #TODO: GITHUB_REPOSITORY var necessary for testing purposes and can ultimately be removed.
+    #todo: is repo_name actually being passed in?
+    repo_name = os.getenv("GITHUB_REPOSITORY")
+    print(f"Verifying linked issues for PR #{pr_num} in {repo_name}")
+
+    g = Github(auth=Auth.Token(token))
+    repo = g.get_repo(repo_name)
+    pr = repo.get_pull(pr_num)
+
+    # 1. Parse PR body for linked issues (e.g., #123 or Fixes #123)
+    pr_body_original = pr.body or ""
+    pr_body = clean_pr_body(pr_body_original)
+
+    issue_numbers = re.findall(r"(?:#|issues\/)(\d+)", pr_body)
+    print(f"Found issue numbers: {issue_numbers}")
+
+    if not issue_numbers:
+        print('ERROR: No linked issues found in the PR description.')
+        return 1
+
+    #2: Check each linked issue for the "ready" command.
+    # If there is more than one issue linked, each issue must be marked /ready
+    found_ready = False
+    for issue_num in issue_numbers:
+        issue = repo.get_issue(int(issue_num))
+        comments = issue.get_comments()
+
+        # Check if the issue contains a comment with /ready command
+        for comment in comments:
+            if "/ready" in comment.body:
+                print(f"Found '/ready' command in issue #{issue_num}")
+                found_ready = True
+                break
+        if found_ready: break
+
+    if not found_ready:
+        print("ERROR: The linked issue(s) must have a '/ready' command.")
+        return 1
+
+    print(f'Successfully verified linked issues: {issue_numbers}')
+    return 0
+
+if __name__ == "__main__":
+    sys.exit(main())

.github/workflows/issue-triage.yml

@@ -0,0 +1,13 @@
+# Triage issues upon opening.
+name: issue-triage.yml
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  on-issue-opened:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Welcome message
+        run: echo "A new issue was created!"

.github/workflows/pr-gatekeeper.yml

@@ -33,7 +33,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PR_NUMBER: ${{ github.event.pull_request.number }}
         run: |
-          python3 .github/scripts/verify-linked-issue.py
+          python3 .github/scripts/verify-pr-ready.py
 
       - name: Retrieve Workflow IDs if Validation Failed
         id: workflow-list