chore(ci): move error prone env to code as constants

Author: heitorlessa

.github/scripts/constants.js

@@ -1,20 +1,35 @@
 module.exports = Object.freeze({
     /** @type {string} */
+    // Values: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
     "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} */
+    "LABEL_BLOCK": "do-not-merge",
+
     /** @type {string} */
-    "BLOCK_LABEL": "do-not-merge",
+    "LABEL_BLOCK_REASON": "need-issue",
+
     /** @type {string} */
-    "BLOCK_REASON_LABEL": "need-issue",
+    "LABEL_PENDING_RELEASE": "pending-release",
+
+    /** @type {string} */
+    "HANDLE_MAINTAINERS_TEAM": "@awslabs/aws-lambda-powertools-python",
+
+    /** @type {string[]} */
+    "IGNORE_AUTHORS": ["dependabot[bot]", "markdownify[bot]"],
 });

.github/scripts/label_missing_related_issue.js

@@ -4,8 +4,8 @@ const {
   PR_BODY,
   PR_NUMBER,
   IGNORE_AUTHORS,
-  BLOCK_LABEL,
-  BLOCK_REASON_LABEL
+  LABEL_BLOCK,
+  LABEL_BLOCK_REASON
 } = require("./constants")
 
 module.exports = async ({github, context, core}) => {
@@ -39,7 +39,7 @@ module.exports = async ({github, context, core}) => {
           issue_number: PR_NUMBER,
           owner: context.repo.owner,
           repo: context.repo.repo,
-          labels: [BLOCK_LABEL, BLOCK_REASON_LABEL]
+          labels: [LABEL_BLOCK, LABEL_BLOCK_REASON]
         })
     }
 }

.github/scripts/label_pr_based_on_title.js

@@ -1,8 +1,8 @@
-module.exports = async ({github, context, core}) => {
-    const pr_number = process.env.PR_NUMBER
-    const pr_title = process.env.PR_TITLE
+const { PR_NUMBER, PR_TITLE } = require("./constants")
 
-    console.log(pr_title)
+module.exports = async ({github, context, core}) => {
+    core.debug(PR_NUMBER);
+    core.debug(PR_TITLE);
 
     const FEAT_REGEX = /feat(\((.+)\))?(\:.+)/
     const BUG_REGEX = /(fix|bug)(\((.+)\))?(\:.+)/
@@ -20,14 +20,15 @@ module.exports = async ({github, context, core}) => {
         "deprecated": DEPRECATED_REGEX,
     }
 
+    // Maintenance: We should keep track of modified PRs in case their titles change
     for (const label in labels) {
         const matcher = new RegExp(labels[label])
-        const isMatch = matcher.exec(pr_title)
+        const isMatch = matcher.exec(PR_TITLE)
         if (isMatch != null) {
-            console.info(`Auto-labeling PR ${pr_number} with ${label}`)
+            core.info(`Auto-labeling PR ${PR_NUMBER} with ${label}`)
 
             await github.rest.issues.addLabels({
-            issue_number: pr_number,
+            issue_number: PR_NUMBER,
             owner: context.repo.owner,
             repo: context.repo.repo,
             labels: [label]
@@ -36,4 +37,6 @@ module.exports = async ({github, context, core}) => {
             break
         }
     }
+
+    return core.notice(`PR ${PR_NUMBER} title '${PR_TITLE}' doesn't follow semantic titles; skipping...`)
 }

.github/scripts/label_related_issue.js

@@ -1,19 +1,35 @@
+const {
+  PR_AUTHOR,
+  PR_BODY,
+  PR_NUMBER,
+  IGNORE_AUTHORS,
+  LABEL_PENDING_RELEASE,
+  HANDLE_MAINTAINERS_TEAM,
+  PR_IS_MERGED,
+} = require("./constants")
+
 module.exports = async ({github, context, core}) => {
-    const prBody = process.env.PR_BODY;
-    const prNumber = process.env.PR_NUMBER;
-    const releaseLabel = process.env.RELEASE_LABEL;
-    const maintainersTeam = process.env.MAINTAINERS_TEAM;
-    const RELATED_ISSUE_REGEX = /Issue number:[^\d\r\n]+(?<issue>\d+)/;
+    core.debug(PR_BODY);
+    core.debug(PR_IS_MERGED);
+
+    if (IGNORE_AUTHORS.includes(PR_AUTHOR)) {
+      return core.notice("Author in IGNORE_AUTHORS list; skipping...")
+    }
 
-    core.info(prBody);
-    const isMatch = RELATED_ISSUE_REGEX.exec(prBody);
+    if (!PR_IS_MERGED) {
+      return core.notice("Only merged PRs 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) {
-      core.setFailed(`Unable to find related issue for PR number ${prNumber}.\n\n Body details: ${prBody}`);
+      core.setFailed(`Unable to find related issue for PR number ${PR_NUMBER}.\n\n Body details: ${PR_BODY}`);
       return await github.rest.issues.createComment({
         owner: context.repo.owner,
         repo: context.repo.repo,
-        body: `${maintainersTeam} No related issues found. Please ensure '${releaseLabel}' label is applied before releasing.`,
-        issue_number: prNumber,
+        body: `${HANDLE_MAINTAINERS_TEAM} No related issues found. Please ensure '${LABEL_PENDING_RELEASE}' label is applied before releasing.`,
+        issue_number: PR_NUMBER,
       });
     }
 
@@ -24,6 +40,6 @@ module.exports = async ({github, context, core}) => {
       issue_number: relatedIssueNumber,
       owner: context.repo.owner,
       repo: context.repo.repo,
-      labels: [releaseLabel]
+      labels: [LABEL_PENDING_RELEASE]
     })
 }

.github/workflows/on_merged_pr.yml

@@ -6,10 +6,6 @@ on:
     types:
       - completed
 
-env:
-  RELEASE_LABEL: "pending-release"
-  MAINTAINERS_TEAM: "@awslabs/aws-lambda-powertools-python"
-
 jobs:
   get_pr_details:
     if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
@@ -26,12 +22,16 @@ jobs:
       && needs.get_pr_details.outputs.prIsMerged == true
     runs-on: ubuntu-latest
     steps:
+      - name: Debug outputs
+        run: echo "Outputs ${{ toJSON(needs.get_pr_details.outputs) }}"
       - uses: actions/checkout@v3
       - name: "Label PR related issue for release"
         uses: actions/github-script@v6
         env:
           PR_NUMBER: ${{ needs.get_pr_details.outputs.prNumber }}
           PR_BODY: ${{ needs.get_pr_details.outputs.prBody }}
+          PR_IS_MERGED: ${{ needs.get_pr_details.outputs.prIsMerged }}
+          PR_AUTHOR: ${{ needs.get_pr_details.outputs.prAuthor }}
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |

.github/workflows/on_opened_pr.yml

@@ -1,4 +1,4 @@
-name: On PR open
+name: On new PR
 
 on:
   workflow_run: