Merge branch 'develop' of github.com:awslabs/aws-lambda-powertools-python into develop

Author: Alexander Melnyk

.chglog/CHANGELOG.tpl.md

@@ -1,10 +1,13 @@
+<!-- changelog is partially generated, so it doesn't follow headings and required structure, so we disable it. -->
+<!-- markdownlint-disable -->
+
 {{ if .Versions -}}
 <a name="unreleased"></a>
-## Unreleased
+# Unreleased
 
 {{ if .Unreleased.CommitGroups -}}
 {{ range .Unreleased.CommitGroups -}}
-### {{ .Title }}
+## {{ .Title }}
 
 {{ range .Commits -}}
 * {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
@@ -17,22 +20,23 @@
 <a name="{{ .Tag.Name }}"></a>
 ## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
 {{ range .CommitGroups -}}
-### {{ .Title }}
+
+## {{ .Title }}
 
 {{ range .Commits -}}
 * {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
 {{ end }}
 {{ end -}}
 
 {{- if .RevertCommits -}}
-### Reverts
+## Reverts
 {{ range .RevertCommits -}}
 * {{ .Revert.Header }}
 {{ end }}
 {{ end -}}
 
 {{- if .MergeCommits -}}
-### Pull Requests
+## Pull Requests
 
 {{ range .MergeCommits -}}
 * {{ .Header }}
@@ -41,7 +45,7 @@
 
 {{- if .NoteGroups -}}
 {{ range .NoteGroups -}}
-### {{ .Title }}
+## {{ .Title }}
 {{ range .Notes }}
 {{ .Body }}
 {{ end }}

.chglog/config.yml

@@ -32,3 +32,6 @@ options:
   notes:
     keywords:
       - BREAKING CHANGE
+  # issues:
+  #   prefix:
+  #     - #

.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,54 @@
+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?.replace(/"/g, '') || "",
+
+    /** @type {string} */
+    "PR_AUTHOR": process.env.PR_AUTHOR?.replace(/"/g, '') || "",
+
+    /** @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 {string} */
+    "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]"],
+
+    /** @type {string[]} */
+    "AREAS": [
+        "tracer",
+        "metrics",
+        "utilities",
+        "logger",
+        "event_handlers",
+        "middleware_factory",
+        "idempotency",
+        "event_sources",
+        "feature_flags",
+        "parameters",
+        "batch",
+        "parser",
+        "validator",
+        "jmespath_util",
+        "lambda-layers",
+    ],
+});

.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,40 @@
+const {
+  PR_ACTION,
+  PR_AUTHOR,
+  PR_BODY,
+  PR_NUMBER,
+  IGNORE_AUTHORS,
+  LABEL_BLOCK,
+  LABEL_BLOCK_REASON
+} = require("./constants")
+
+module.exports = async ({github, context, core}) => {
+    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,60 @@
+const { PR_NUMBER, PR_TITLE, AREAS } = require("./constants")
+
+module.exports = async ({github, context, core}) => {
+    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
+    let miss = 0;
+    try {
+        for (const label in labels) {
+            const matcher = new RegExp(labels[label])
+            const matches = matcher.exec(PR_TITLE)
+            if (matches != 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]
+                })
+
+                const area = matches[2]; // second capture group contains the area
+                if (AREAS.indexOf(area) > -1) {
+                    core.info(`Auto-labeling PR ${PR_NUMBER} with area ${area}`);
+                    await github.rest.issues.addLabels({
+                        issue_number: PR_NUMBER,
+                        owner: context.repo.owner,
+                        repo: context.repo.repo,
+                        labels: [`area/${area}`],
+                    });
+                } else {
+                    core.debug(`'${PR_TITLE}' didn't match any known area.`);
+                }
+
+                return;
+            } else {
+                core.debug(`'${PR_TITLE}' didn't match '${label}' semantic.`)
+                miss += 1
+            }
+        }
+    } finally {
+        if (miss == Object.keys(labels).length) {
+            core.notice(`PR ${PR_NUMBER} title '${PR_TITLE}' doesn't follow semantic titles; skipping...`)
+        }
+    }
+}

.github/scripts/label_related_issue.js

@@ -1,20 +1,54 @@
-module.exports = async ({github, context}) => {
-    const prBody = context.payload.body;
-    const prNumber = context.payload.number;
-    const releaseLabel = process.env.RELEASE_LABEL;
-    const maintainersTeam = process.env.MAINTAINERS_TEAM
+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}) => {
+    if (IGNORE_AUTHORS.includes(PR_AUTHOR)) {
+      return core.notice("Author in IGNORE_AUTHORS list; skipping...")
+    }
+
+    if (PR_IS_MERGED == "false") {
+      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(prBody);
-    if (!isMatch) {
-      core.setFailed(`Unable to find related issue for PR number ${prNumber}.\n\n Body details: ${prBody}`);
-      return await github.rest.issues.createComment({
+    const isMatch = RELATED_ISSUE_REGEX.exec(PR_BODY);
+
+    try {
+      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,
+        });
+      }
+    } catch (error) {
+      core.setFailed(`Unable to create comment on PR number ${PR_NUMBER}.\n\n Error details: ${error}`);
+      throw new Error(error);
+    }
+
+    const { groups: {issue} } = isMatch
+
+    try {
+      core.info(`Auto-labeling related issue ${issue} for release`)
+      await github.rest.issues.addLabels({
+        issue_number: issue,
         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,
-      });
+        labels: [LABEL_PENDING_RELEASE]
+      })
+    } catch (error) {
+      core.setFailed(`Is this issue number (${issue}) valid? Perhaps a discussion?`);
+      throw new Error(error);
     }
 
     const { groups: {relatedIssueNumber} } = isMatch

.github/workflows/post_release.js renamed to .github/scripts/post_release.js

@@ -100,13 +100,13 @@ const notifyRelease = async ({
 
 // context: https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts
 module.exports = async ({ github, context }) => {
-	const { RELEASE_TAG_VERSION } = process.env;
-	console.log(`Running post-release script for ${RELEASE_TAG_VERSION} version`);
+	const { RELEASE_VERSION } = process.env;
+	console.log(`Running post-release script for ${RELEASE_VERSION} version`);
 
 	await notifyRelease({
 		gh_client: github,
 		owner: context.repo.owner,
 		repository: context.repo.repo,
-		release_version: RELEASE_TAG_VERSION,
+		release_version: RELEASE_VERSION,
 	});
 };

.github/scripts/save_pr_details.js

@@ -0,0 +1,13 @@
+module.exports = async ({context, core}) => {
+    const fs = require('fs');
+    const filename = "pr.txt";
+
+    try {
+        fs.writeFileSync(`./${filename}`, JSON.stringify(context.payload));
+
+        return `PR successfully saved ${filename}`
+    } catch (err) {
+        core.setFailed("Failed to save PR details");
+        console.error(err);
+    }
+}