fix(ci): move conditionals from yaml to code

Author: heitorlessa

.github/scripts/constants.js

@@ -0,0 +1,20 @@
+module.exports = Object.freeze({
+    /** @type {string} */
+    "PR_ACTION": process.env.PR_ACTION || "",
+    /** @type {string} */
+    "PR_AUTHOR": process.env.PR_AUTHOR || "",
+    /** @type {string} */
+    "PR_BODY": process.env.PR_BODY || "",
+    /** @type {string} */
+    "PR_TITLE": process.env.PR_TITLE || "",
+    /** @type {number} */
+    "PR_NUMBER": process.env.PR_NUMBER || 0,
+    /** @type {boolean} */
+    "PR_IS_MERGED": process.env.PR_IS_MERGED || false,
+    /** @type {string[]} */
+    "IGNORE_AUTHORS": ["dependabot[bot]", "markdownify[bot]"],
+    /** @type {string} */
+    "BLOCK_LABEL": "do-not-merge",
+    /** @type {string} */
+    "BLOCK_REASON_LABEL": "need-issue",
+});

.github/scripts/label_missing_related_issue.js

@@ -1,12 +1,29 @@
+const {
+  PR_ACTION,
+  PR_AUTHOR,
+  PR_BODY,
+  PR_NUMBER,
+  IGNORE_AUTHORS,
+  BLOCK_LABEL,
+  BLOCK_REASON_LABEL
+} = require("./constants")
+
 module.exports = async ({github, context, core}) => {
-    const prBody = process.env.PR_BODY;
-    const prNumber = process.env.PR_NUMBER;
-    const blockLabel = process.env.BLOCK_LABEL;
-    const blockReasonLabel = process.env.BLOCK_REASON_LABEL;
+    core.debug(`Number: ${PR_BODY}`);
+    core.debug(`Action: ${PR_ACTION}`);
+    core.debug(`Author: ${PR_AUTHOR}`);
+    core.debug(`Body: ${PR_BODY}`);
 
-    const RELATED_ISSUE_REGEX = /Issue number:[^\d\r\n]+(?<issue>\d+)/;
+    if (IGNORE_AUTHORS.includes(PR_AUTHOR)) {
+      return core.notice("Author in IGNORE_AUTHORS list; skipping...")
+    }
 
-    const isMatch = RELATED_ISSUE_REGEX.exec(prBody);
+    if (PR_ACTION != "opened") {
+      return core.notice("Only newly open PRs are labelled to avoid spam; skipping")
+    }
+
+    const RELATED_ISSUE_REGEX = /Issue number:[^\d\r\n]+(?<issue>\d+)/;
+    const isMatch = RELATED_ISSUE_REGEX.exec(PR_BODY);
     if (isMatch == null) {
         core.info(`No related issue found, maybe the author didn't use the template but there is one.`)
 
@@ -15,14 +32,14 @@ module.exports = async ({github, context, core}) => {
           owner: context.repo.owner,
           repo: context.repo.repo,
           body: msg,
-          issue_number: prNumber,
+          issue_number: PR_NUMBER,
         });
 
         return await github.rest.issues.addLabels({
-          issue_number: prNumber,
+          issue_number: PR_NUMBER,
           owner: context.repo.owner,
           repo: context.repo.repo,
-          labels: [blockLabel, blockReasonLabel]
+          labels: [BLOCK_LABEL, BLOCK_REASON_LABEL]
         })
     }
 }

.github/workflows/on_opened_pr.yml

@@ -6,10 +6,6 @@ on:
     types:
       - completed
 
-env:
-  BLOCK_LABEL: "do-not-merge"
-  BLOCK_REASON_LABEL: "need-issue"
-  IGNORE_AUTHORS: '["dependabot[bot]", "markdownify[bot]"]'
 
 jobs:
   get_pr_details:
@@ -21,18 +17,20 @@ jobs:
       token: ${{ secrets.GITHUB_TOKEN }}
   check_related_issue:
     needs: get_pr_details
-    # Maintenance: Refactor condition to the correct env syntax later
-    if: |
-      needs.get_pr_details.outputs.prAction == 'opened'
-      && contains(fromJson('["dependabot[bot]", "markdownify[bot]"]'), needs.get_pr_details.outputs.prAuthor) != true
     runs-on: ubuntu-latest
     steps:
+      - name: Debug outputs
+        run: echo "Outputs ${{ toJSON(needs.get_pr_details.outputs) }}"
       - uses: actions/checkout@v3
       - name: "Ensure related issue is present"
+        if: contains('["opened", "edited"]', needs.get_pr_details.outputs.prAction)
+        if: needs.get_pr_details.outputs.prAction == 'opened' || needs.get_pr_details.outputs.prAction == 'edited'
         uses: actions/github-script@v6
         env:
           PR_BODY: ${{ needs.get_pr_details.outputs.prBody }}
           PR_NUMBER: ${{ needs.get_pr_details.outputs.prNumber }}
+          PR_ACTION: ${{ needs.get_pr_details.outputs.prAction }}
+          PR_AUTHOR: ${{ needs.get_pr_details.outputs.prAuthor }}
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |