Merge pull request #7 from alyssacgoins/gh-actions-pr-check

GH actions verify PR.

Author: alyssacgoins

.github/scripts/verify-linked-issue.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+import os
+import re
+import sys
+
+from github import Github
+
+def main() -> int:
+    # Retrieve env vars provided by GH Action workflow
+    token = os.getenv("GITHUB_TOKEN")
+    pr_num = int(os.getenv("PR_NUMBER"))
+
+    g = Github(token)
+    #todo: what is the func expecting for input formatting?
+    repo = g.get_repo("kubeflow/pipelines")
+    pr = repo.get_pull(pr_num)
+
+    # 1. Parse PR body for linked issues (e.g., #123 or Fixes #123)
+    pr_body = pr.body or ""
+    issue_numbers = re.findall(r"(?:#|issues\/)(\d+)", pr_body)
+
+    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:
+        #todo: case in which issue_num cannot be converted into an int?
+        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
+        #todo: is there ever a case in which "/ready" is canceled out by a later comment? (ie do not exit here)
+        if found_ready: break
+
+    if not found_ready:
+        print("ERROR: The linked issue(s) must have a '/ready' command.")
+        return 1
+
+    #todo: add successful return message.
+    print()
+    return 0
+
+if __name__ == "__main__":
+    sys.exit(main())
+
+

.github/workflows/verify-pr.yml

@@ -0,0 +1,42 @@
+# Validate
+name: Verify PR
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  # JOB 1: Performs the check for non-members
+  check-issue:
+#    if: |
+#      github.event.pull_request.author_association != 'MEMBER' &&
+#      github.event.pull_request.author_association != 'OWNER'
+    runs-on: ubuntu-latest
+    steps:
+      #todo: I do not believe we need checkout code action, as we use only PR body
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          #todo: verify this version
+          python-version: "3.10"
+
+      - name: Install Dependencies
+        run: |
+          pip install ruamel.yaml
+
+      - name: Verify Linked Issue is Valid
+        run: |
+          python3 .github/scripts/verify-linked-issue.py
+
+  # JOB 2: Posts a comment only if the author IS a member
+  skip-notification:
+    if: |
+      github.event.pull_request.author_association == 'MEMBER' || 
+      github.event.pull_request.author_association == 'OWNER'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Post skip message
+        uses: thollander/actions-comment-pull-request@v3
+        with:
+          message: |
+            👋 Hello! Since you are a member of the Kubeflow organization, the "Linked Issue" check has been automatically bypassed for this PR.