feat(ci): add workflow to remind pull requests to link issues (#1173)

Signed-off-by: undefinedIsMyLife <shinetina169@gmail.com>

Author: undefinedIsMyLife

.github/scripts/pr_missing_linked_issue.js

@@ -0,0 +1,45 @@
+module.exports = async ({ github, context }) => {
+  const body = context.payload.pull_request.body || "";
+  const regex = /\bFixes\s*:?\s*(#\d+)(\s*,\s*#\d+)*/i;
+
+  const comments = await github.rest.issues.listComments({
+  owner: context.repo.owner,
+  repo: context.repo.repo,
+  issue_number: context.payload.pull_request.number,
+  });
+
+  const alreadyCommented = comments.data.some(comment =>
+    comment.body.includes("this is LinkBot")
+  );
+
+  if (alreadyCommented) {
+    return;
+  }
+
+  if (!regex.test(body)) {
+    await github.rest.issues.createComment({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      issue_number: context.payload.pull_request.number,
+      body: [
+        `Hi @${context.payload.pull_request.user.login}, this is **LinkBot** 👋`,
+        ``,
+        `Linking pull requests to issues helps us significantly with reviewing pull requests and keeping the repository healthy.`,
+        ``,
+        `🚨 **This pull request does not have an issue linked.**`,
+        ``,
+        `Please link an issue using the following format:`,
+        `- Fixes #123`,
+        ``,
+        `📖 Guide:`,
+        `docs/sdk_developers/how_to_link_issues.md`,
+        ``,
+        `If no issue exists yet, please create one:`,
+        `docs/sdk_developers/creating_issues.md`,
+        ``,
+        `Thanks!`
+      ].join('\n')
+    });
+  }
+};
+

.github/workflows/pr-missing-linked-issue.yml

@@ -0,0 +1,35 @@
+name: PR Missing Linked Issue Reminder
+
+on:
+  pull_request:
+    types: [opened, edited, reopened]
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  check-linked-issue:
+    runs-on: ubuntu-latest
+
+    concurrency:
+      group: pr-missing-linked-issue-${{ github.event.pull_request.number }}
+      cancel-in-progress: true
+
+    steps:
+      - name: Harden the runner
+        uses: step-security/harden-runner@20cf305ff2072d973412fa9b1e3a4f227bda3c76 # v2.14.0
+        with:
+          egress-policy: audit
+
+      - name: Checkout repository
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+
+      - name: Check PR body for linked issue
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        with:
+          script: |
+            const script = require('./.github/scripts/pr_missing_linked_issue.js');
+            await script({ github, context });

CHANGELOG.md

@@ -9,6 +9,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 
 
 ### Added
+- Added a GitHub Actions workflow that reminds contributors to link pull requests to issues.
 - Added `__str__` and `__repr__` methods to `AccountInfo` class for improved logging and debugging experience (#1098)
 - Added Good First Issue (GFI) management and frequency documentation to clarify maintainer expectations and SDK-level GFI governance.
 - Added SDK-level Good First Issue (GFI) guidelines for maintainers to clarify what qualifies as a good first issue.

docs/sdk_developers/creating_issues.md

@@ -0,0 +1,13 @@
+# Creating an issue for your pull request
+
+If your pull request does not yet have an issue:
+
+1. Go to the repository Issues tab
+2. Click "New issue"
+3. Fill in the issue template with the problem description
+4. Assign yourself if applicable
+5. Copy the issue number
+
+Then link the issue in your pull request description using:
+
+Fixes #ISSUE_NUMBER

docs/sdk_developers/how_to_link_issues.md

@@ -0,0 +1,13 @@
+# How to link an issue to a pull request
+
+To link a pull request to an issue, add one of the following lines
+to the **pull request description**:
+
+- Fixes #ISSUE_NUMBER
+
+Example:
+
+Fixes #123
+
+This helps reviewers understand the context of the change and allows
+GitHub to automatically manage issue state.