Merge branch 'develop' into feature/e2e-tests

Author: Michal Ploski

.github/mergify.yml

@@ -22,7 +22,6 @@
 
 #   - name: Automatic merge ⬇️ on approval ✔
 #     conditions:
-#       - base!=master
 #       - "#approved-reviews-by>=2"
 #     actions:
 #       queue:

.github/scripts/constants.js

@@ -0,0 +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} */
+    "LABEL_BLOCK": "do-not-merge",
+
+    /** @type {string} */
+    "LABEL_BLOCK_REASON": "need-issue",
+
+    /** @type {string} */
+    "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/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));
+}

.github/scripts/label_missing_related_issue.js

@@ -0,0 +1,45 @@
+const {
+  PR_ACTION,
+  PR_AUTHOR,
+  PR_BODY,
+  PR_NUMBER,
+  IGNORE_AUTHORS,
+  LABEL_BLOCK,
+  LABEL_BLOCK_REASON
+} = require("./constants")
+
+module.exports = async ({github, context, core}) => {
+    core.debug(`Number: ${PR_BODY}`);
+    core.debug(`Action: ${PR_ACTION}`);
+    core.debug(`Author: ${PR_AUTHOR}`);
+    core.debug(`Body: ${PR_BODY}`);
+
+    if (IGNORE_AUTHORS.includes(PR_AUTHOR)) {
+      return core.notice("Author in IGNORE_AUTHORS list; skipping...")
+    }
+
+    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.`)
+
+        let msg = "No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure.";
+        await github.rest.issues.createComment({
+          owner: context.repo.owner,
+          repo: context.repo.repo,
+          body: msg,
+          issue_number: PR_NUMBER,
+        });
+
+        return await github.rest.issues.addLabels({
+          issue_number: PR_NUMBER,
+          owner: context.repo.owner,
+          repo: context.repo.repo,
+          labels: [LABEL_BLOCK, LABEL_BLOCK_REASON]
+        })
+    }
+}

.github/scripts/label_pr_based_on_title.js

@@ -0,0 +1,42 @@
+const { PR_NUMBER, PR_TITLE } = require("./constants")
+
+module.exports = async ({github, context, core}) => {
+    core.debug(PR_NUMBER);
+    core.debug(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,
+    }
+
+    // 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)
+        if (isMatch != null) {
+            core.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
+        }
+    }
+
+    return core.notice(`PR ${PR_NUMBER} title '${PR_TITLE}' doesn't follow semantic titles; skipping...`)
+}

.github/scripts/label_related_issue.js

@@ -0,0 +1,46 @@
+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}) => {
+    core.debug(PR_BODY);
+    core.debug(PR_IS_MERGED);
+    core.debug(PR_AUTHOR);
+
+    if (IGNORE_AUTHORS.includes(PR_AUTHOR)) {
+      return core.notice("Author in IGNORE_AUTHORS list; skipping...")
+    }
+
+    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 ${PR_NUMBER}.\n\n Body details: ${PR_BODY}`);
+      return await github.rest.issues.createComment({
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        body: `${HANDLE_MAINTAINERS_TEAM} No related issues found. Please ensure '${LABEL_PENDING_RELEASE}' label is applied before releasing.`,
+        issue_number: PR_NUMBER,
+      });
+    }
+
+    const { groups: {issue} } = isMatch
+
+    core.info(`Auto-labeling related issue ${issue} for release`)
+    return await github.rest.issues.addLabels({
+      issue_number: issue,
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      labels: [LABEL_PENDING_RELEASE]
+    })
+}

.github/workflows/post_release.js renamed to .github/scripts/post_release.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);
+    }
+}

.github/scripts/save_pr_details.js

@@ -14,11 +14,25 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.1.1
+        uses: dependabot/fetch-metadata@v1.3.3
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Enable auto-merge for mypy-boto3 stubs Dependabot PRs
-        if: ${{contains(steps.metadata.outputs.dependency-names, 'mypy-boto3')}} # && steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        if: ${{ contains(steps.metadata.outputs.dependency-names, 'mypy-boto3') && steps.metadata.outputs.update-type != 'version-update:semver-major' }}
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      # Maintenance: Experiment with literal array (toJSON('["dep1", "dep2"]')) to ease extending it
+      - name: Enable auto-merge for CDK Construct Lambda Layer Dependabot PRs
+        if: ${{ contains(steps.metadata.outputs.dependency-names, 'cdk-lambda-powertools-python-layer') && steps.metadata.outputs.update-type != 'version-update:semver-major' }}
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      # Maintenance: Revisit if CDK Constructs make breaking changes like CDK v1
+      - name: Enable auto-merge for CDK Lib Construct
+        if: ${{ contains(steps.metadata.outputs.dependency-names, 'aws-cdk-lib') && steps.metadata.outputs.update-type != 'version-update:semver-major' }}
         run: gh pr merge --auto --squash "$PR_URL"
         env:
           PR_URL: ${{github.event.pull_request.html_url}}