samhays · dependabot · Jul 8, 2022 · Jul 8, 2022 · Jul 11, 2022 · Jul 11, 2022
diff --git a/.github/scripts/download_pr_artifact.js b/.github/scripts/download_pr_artifact.js
@@ -0,0 +1,26 @@
+module.exports = async ({github, context, core}) => {
+    const fs = require('fs');
+
+    const workflowRunId = process.env.WORKFLOW_ID;
+    core.info(`Listing artifacts for workflow run ${workflowRunId}`);
+
+    const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      run_id: workflowRunId,
+    });
+
+    const matchArtifact = artifacts.data.artifacts.filter(artifact => artifact.name == "pr")[0];
+
+    core.info(`Downloading artifacts for workflow run ${workflowRunId}`);
+    const artifact = await github.rest.actions.downloadArtifact({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      artifact_id: matchArtifact.id,
+      archive_format: 'zip',
+    });
+
+    core.info("Saving artifact found", artifact);
+
+    fs.writeFileSync('pr.zip', Buffer.from(artifact.data));
+}
diff --git a/.github/scripts/label_pr_based_on_title.js b/.github/scripts/label_pr_based_on_title.js
@@ -0,0 +1,39 @@
+module.exports = async ({github, context, core}) => {
+    const pr_number = process.env.PR_NUMBER
+    const pr_title = process.env.PR_TITLE
+
+    console.log(pr_title)
+
+    const FEAT_REGEX = /feat(\((.+)\))?(\:.+)/
+    const BUG_REGEX = /(fix|bug)(\((.+)\))?(\:.+)/
+    const DOCS_REGEX = /(docs|doc)(\((.+)\))?(\:.+)/
+    const CHORE_REGEX = /(chore)(\((.+)\))?(\:.+)/
+    const DEPRECATED_REGEX = /(deprecated)(\((.+)\))?(\:.+)/
+    const REFACTOR_REGEX = /(refactor)(\((.+)\))?(\:.+)/
+
+    const labels = {
+        "feature": FEAT_REGEX,
+        "bug": BUG_REGEX,
+        "documentation": DOCS_REGEX,
+        "internal": CHORE_REGEX,
+        "enhancement": REFACTOR_REGEX,
+        "deprecated": DEPRECATED_REGEX,
+    }
+
+    for (const label in labels) {
+        const matcher = new RegExp(labels[label])
+        const isMatch = matcher.exec(pr_title)
+        if (isMatch != null) {
+            console.info(`Auto-labeling PR ${pr_number} with ${label}`)
+
+            await github.rest.issues.addLabels({
+            issue_number: pr_number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            labels: [label]
+            })
+
+            break
+        }
+    }
+}
diff --git a/.github/scripts/label_related_issue.js b/.github/scripts/label_related_issue.js
@@ -1,8 +1,10 @@
-module.exports = async ({github, context}) => {
-    const prBody = context.payload.body;
-    const prNumber = context.payload.number;
+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 maintainersTeam = process.env.MAINTAINERS_TEAM;
+
+    console.log(prBody);
 
     const RELATED_ISSUE_REGEX = /Issue number:[^\d\r\n]+(?<issue>\d+)/;
 

diff --git a/.github/scripts/save_pr_details.js b/.github/scripts/save_pr_details.js
@@ -0,0 +1,15 @@
+module.exports = async ({github, context, core}) => {
+    const fs = require('fs');
+    const filename = "pr.txt";
+
+    try {
+        core.debug("Payload as it comes..");
+        core.debug(context.payload);
+        fs.writeFileSync(`./${filename}`, JSON.stringify(context.payload));
+
+        return `PR successfully saved ${filename}`
+    } catch (err) {
+        core.setFailed("Failed to save PR details");
+        console.error(err);
+    }
+}
diff --git a/.github/workflows/export_pr_details.yml b/.github/workflows/export_pr_details.yml
diff --git a/.github/workflows/label_pr_on_title.yml b/.github/workflows/label_pr_on_title.yml
@@ -2,86 +2,36 @@ name: Label PR based on title
 
 on:
   workflow_run:
-    workflows: ["Record PR number"]
+    workflows: ["Record PR details"]
     types:
       - completed
 
 jobs:
-  upload:
-    runs-on: ubuntu-latest
+  get_pr_details:
     # Guardrails to only ever run if PR recording workflow was indeed
     # run in a PR event and ran successfully
-    if: >
-      ${{ github.event.workflow_run.event == 'pull_request' &&
-      github.event.workflow_run.conclusion == 'success' }}
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    uses: ./.github/workflows/reusable_export_pr_details.yml
+    with:
+      record_pr_workflow_id: ${{ github.event.workflow_run.id }}
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+  label_pr:
+    needs: get_pr_details
+    runs-on: ubuntu-latest
     steps:
-      - name: 'Download artifact'
-        uses: actions/github-script@v6
-        # For security, we only download artifacts tied to the successful PR recording workflow
-        with:
-          script: |
-            const fs = require('fs');
-
-            const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
-               owner: context.repo.owner,
-               repo: context.repo.repo,
-               run_id: ${{github.event.workflow_run.id }},
-            });
-
-            const matchArtifact = artifacts.data.artifacts.filter(artifact => artifact.name == "pr")[0];
-
-            const artifact = await github.rest.actions.downloadArtifact({
-               owner: context.repo.owner,
-               repo: context.repo.repo,
-               artifact_id: matchArtifact.id,
-               archive_format: 'zip',
-            });
-
-            fs.writeFileSync('${{github.workspace}}/pr.zip', Buffer.from(artifact.data));
-      # NodeJS standard library doesn't provide ZIP capabilities; use system `unzip` command instead
-      - run: unzip pr.zip
-
-      - name: 'Label PR based on title'
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: "Label PR based on title"
         uses: actions/github-script@v6
+        env:
+          PR_NUMBER: ${{ needs.get_pr_details.outputs.prNumber }}
+          PR_TITLE: ${{ needs.get_pr_details.outputs.prTitle }}
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           # This safely runs in our base repo, not on fork
           # thus allowing us to provide a write access token to label based on PR title
           # and label PR based on semantic title accordingly
           script: |
-            const fs = require('fs');
-            const pr_number = Number(fs.readFileSync('./number'));
-            const pr_title = fs.readFileSync('./title', 'utf-8').trim();
-
-            const FEAT_REGEX = /feat(\((.+)\))?(\:.+)/
-            const BUG_REGEX = /(fix|bug)(\((.+)\))?(\:.+)/
-            const DOCS_REGEX = /(docs|doc)(\((.+)\))?(\:.+)/
-            const CHORE_REGEX = /(chore)(\((.+)\))?(\:.+)/
-            const DEPRECATED_REGEX = /(deprecated)(\((.+)\))?(\:.+)/
-            const REFACTOR_REGEX = /(refactor)(\((.+)\))?(\:.+)/
-
-            const labels = {
-                "feature": FEAT_REGEX,
-                "bug": BUG_REGEX,
-                "documentation": DOCS_REGEX,
-                "internal": CHORE_REGEX,
-                "enhancement": REFACTOR_REGEX,
-                "deprecated": DEPRECATED_REGEX,
-            }
-
-            for (const label in labels) {
-                const matcher = new RegExp(labels[label])
-                const isMatch = matcher.exec(pr_title)
-                if (isMatch != null) {
-                    console.info(`Auto-labeling PR ${pr_number} with ${label}`)
-
-                    await github.rest.issues.addLabels({
-                      issue_number: pr_number,
-                      owner: context.repo.owner,
-                      repo: context.repo.repo,
-                      labels: [label]
-                    })
-
-                    break
-                }
-            }
+            const script = require('.github/scripts/label_pr_based_on_title.js')
+            await script({github, context, core})
diff --git a/.github/workflows/on_merged_pr.yml b/.github/workflows/on_merged_pr.yml
@@ -1,26 +1,47 @@
-# Maintenance: Verify why we're having permissions issues even with write scope, then re-enable it.
-# logs: https://github.com/awslabs/aws-lambda-powertools-python/runs/7030238348?check_suite_focus=true
+name: On PR merge
 
 on:
-  pull_request:
+  workflow_run:
+    workflows: ["Record PR details"]
     types:
-      - closed
+      - 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'
+    uses: ./.github/workflows/reusable_export_pr_details.yml
+    with:
+      record_pr_workflow_id: ${{ github.event.workflow_run.id }}
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
   release_label_on_merge:
-    if: github.event.pull_request.merged == true && github.event.pull_request.user.login != 'dependabot[bot]'
+    needs: get_pr_details
+    if: >
+      ${{ needs.get_pr_details.outputs.prAuthor != 'dependabot[bot]' &&
+          needs.get_pr_details.outputs.prAction == 'opened'
+      }}
+    # if: >
+    #   ${{ needs.get_pr_details.outputs.prAuthor != 'dependabot[bot]' &&
+    #       needs.get_pr_details.outputs.prAction == 'opened' &&
+    #       needs.get_pr_details.outputs.prIsMerged == true
+    #   }}
+    # if: ${{ needs.get_pr_details.outputs.prIsMerged == true }}
     runs-on: ubuntu-latest
-    permissions:
-      issues: write # required for new scoped token
-      pull-requests: write # required for new scoped token
     steps:
       - 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_TITLE: ${{ needs.get_pr_details.outputs.prTitle }}
+          PR_BODY: ${{ needs.get_pr_details.outputs.prBody }}
+          PR_AUTHOR: ${{ needs.get_pr_details.outputs.prAuthor }}
+          PR_ACTION: ${{ needs.get_pr_details.outputs.prAction }}
+          PR_MERGE: ${{ needs.get_pr_details.outputs.prIsMerged }}
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |

diff --git a/.github/workflows/on_opened_pr.yml b/.github/workflows/on_opened_pr.yml
@@ -1,17 +1,20 @@
+name: On PR opened
+
 on:
   workflow_run:
-    workflows: ["Record PR number"]
+    workflows: ["Record PR details"]
     types:
       - completed
 
 env:
   BLOCK_LABEL: "do-not-merge"
   BLOCK_REASON_LABEL: "need-issue"
 
+# TODO: include markdownify author too
 jobs:
   get_pr_details:
-    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
-    uses: ./.github/workflows/export_pr_details.yml
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    uses: ./.github/workflows/reusable_export_pr_details.yml
     with:
       record_pr_workflow_id: ${{ github.event.workflow_run.id }}
     secrets:

diff --git a/.github/workflows/record_pr.yml b/.github/workflows/record_pr.yml
@@ -1,24 +1,22 @@
-name: Record PR number
+name: Record PR details
 
 on:
   pull_request:
-    types: [opened, edited]
+    types: [opened, edited, closed]
 
 jobs:
-  build:
+  record_pr:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
-      - name: Save PR number
-        run: |
-          mkdir -p ./pr
-          echo ${{ github.event.number }} > ./pr/number
-          echo "${{ github.event.pull_request.title }}" > ./pr/title
-          echo "${{ github.event.pull_request.body }}" > ./pr/body
-          echo "${{ github.event.pull_request.user.login }}" > ./pr/author
-          echo "${{ github.event.action }}" > ./pr/action
+      - name: "Extract PR details"
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const script = require('.github/scripts/save_pr_details.js')
+            await script({github, context, core})
       - uses: actions/upload-artifact@v3
         with:
           name: pr
-          path: pr/
+          path: pr.txt