chore(deps): bump pydantic from 1.10.1 to 1.10.2

.github/boring-cyborg.yml

@@ -95,6 +95,8 @@ labelPRBasedOnFilePath:
 firstPRWelcomeComment: >
   Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
 
+  In the meantime, check out the #python channel on our AWS Lambda Powertools Discord: [Invite link](https://discord.gg/B8zZKbbyET)
+
 # Comment to be posted to congratulate user on their first merged PR
 firstPRMergeComment: >
   Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!
@@ -103,6 +105,8 @@ firstPRMergeComment: >
 firstIssueWelcomeComment: >
   Thanks for opening your first issue here! We'll come back to you as soon as we can.
 
+  In the meantime, check out the #python channel on our AWS Lambda Powertools Discord: [Invite link](https://discord.gg/B8zZKbbyET)
+
 ###### IssueLink Adder #################################################################################################
 # Insert Issue (Jira/Github etc) link in PR description based on the Issue ID in PR title.
 #insertIssueLinkInPrDescription:

.github/scripts/comment_on_large_pr.js

@@ -0,0 +1,73 @@
+const {
+  PR_NUMBER,
+  PR_ACTION,
+  PR_AUTHOR,
+  IGNORE_AUTHORS,
+} = require("./constants")
+
+
+/**
+ * Notify PR author to split XXL PR in smaller chunks
+ *
+ * @param {object} core - core functions instance from @actions/core
+ * @param {object} gh_client - Pre-authenticated REST client (Octokit)
+ * @param {string} owner - GitHub Organization
+ * @param {string} repository - GitHub repository
+ */
+const notifyAuthor = async ({
+  core,
+  gh_client,
+  owner,
+  repository,
+}) => {
+    core.info(`Commenting on PR ${PR_NUMBER}`)
+
+    let msg = `### ⚠️Large PR detected⚠️
+
+Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.
+    `;
+
+    try {
+      await gh_client.rest.issues.createComment({
+        owner: owner,
+        repo: repository,
+        body: msg,
+        issue_number: PR_NUMBER,
+      });
+    } catch (error) {
+      core.setFailed("Failed to notify PR author to split large PR");
+      console.error(err);
+    }
+}
+
+module.exports = async ({github, context, core}) => {
+    if (IGNORE_AUTHORS.includes(PR_AUTHOR)) {
+      return core.notice("Author in IGNORE_AUTHORS list; skipping...")
+    }
+
+    if (PR_ACTION != "labeled") {
+      return core.notice("Only run on PRs labeling actions; skipping")
+    }
+
+
+    /** @type {string[]} */
+    const { data: labels } = await github.rest.issues.listLabelsOnIssue({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      issue_number: PR_NUMBER,
+    })
+
+    // Schema: https://docs.github.com/en/rest/issues/labels#list-labels-for-an-issue
+    for (const label of labels) {
+      core.info(`Label: ${label}`)
+      if (label.name == "size/XXL") {
+        await notifyAuthor({
+          core: core,
+          gh_client: github,
+          owner: context.repo.owner,
+          repository: context.repo.repo,
+        })
+        break;
+      }
+    }
+}

.github/scripts/label_related_issue.js

@@ -1,53 +1,29 @@
-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 prBody = context.payload.body;
+    const prNumber = context.payload.number;
+    const releaseLabel = process.env.RELEASE_LABEL;
+    const maintainersTeam = process.env.MAINTAINERS_TEAM
 
     const RELATED_ISSUE_REGEX = /Issue number:[^\d\r\n]+(?<issue>\d+)/;
 
-    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`)
-      return await github.rest.issues.addLabels({
-        issue_number: issue,
+    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({
         owner: context.repo.owner,
         repo: context.repo.repo,
-        labels: [LABEL_PENDING_RELEASE]
-      })
-    } catch (error) {
-      core.setFailed(`Is this issue number (${issue}) valid? Perhaps a discussion?`);
-      throw new Error(error);
+        body: `${maintainersTeam} No related issues found. Please ensure '${releaseLabel}' label is applied before releasing.`,
+        issue_number: prNumber,
+      });
     }
+
+    const { groups: {relatedIssueNumber} } = isMatch
+
+    core.info(`Auto-labeling related issue ${relatedIssueNumber} for release`)
+    return await github.rest.issues.addLabels({
+      issue_number: relatedIssueNumber,
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      labels: [releaseLabel]
+    })
 }

.github/workflows/codeql-analysis.yml

@@ -2,7 +2,7 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [develop]
+    branches: [develop, v2]
 
 jobs:
   analyze:
@@ -14,23 +14,23 @@ jobs:
       matrix:
         # Override automatic language detection by changing the below list
         # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
-        language: ['python']
+        language: ["python"]
         # Learn more...
         # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/on_label_added.yml

@@ -0,0 +1,38 @@
+name: On Label added
+
+on:
+  workflow_run:
+    workflows: ["Record PR details"]
+    types:
+      - completed
+
+jobs:
+  get_pr_details:
+    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 }}
+      workflow_origin: ${{ github.event.repository.full_name }}
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+
+  split-large-pr:
+    needs: get_pr_details
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v3
+      # Maintenance: Persist state per PR as an artifact to avoid spam on label add
+      - name: "Suggest split large Pull Request"
+        uses: actions/github-script@v6
+        env:
+          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: |
+            const script = require('.github/scripts/comment_on_large_pr.js');
+            await script({github, context, core});

.github/workflows/on_push_docs.yml

@@ -0,0 +1,35 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - develop
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "examples/**"
+
+jobs:
+  changelog:
+    permissions:
+      contents: write
+    uses: ./.github/workflows/reusable_publish_changelog.yml
+
+  release-docs:
+    needs: changelog
+    permissions:
+      contents: write
+      pages: write
+    uses: ./.github/workflows/reusable_publish_docs.yml
+    with:
+      version: develop
+      alias: stage
+# Maintenance: Only necessary in repo migration
+# - name: Create redirect from old docs
+#   run: |
+#     git checkout gh-pages
+#     test -f 404.html && echo "Redirect already set" && exit 0
+#     git checkout develop -- 404.html
+#     git add 404.html
+#     git commit -m "chore: set docs redirect" --no-verify
+#     git push origin gh-pages -f

.github/workflows/on_release_notes.yml

@@ -69,16 +69,16 @@ jobs:
         id: release_version
         # transform tag format `v<version` to `<version`
         run: |
-          RELEASE_VERSION=${RELEASE_TAG_VERSION:1}
-          echo "RELEASE_VERSION=${RELEASE_VERSION}" >> $GITHUB_ENV
+          RELEASE_VERSION="${RELEASE_TAG_VERSION:1}"
+          echo "RELEASE_VERSION=${RELEASE_VERSION}" >> "$GITHUB_ENV"
           echo "::set-output name=RELEASE_VERSION::${RELEASE_VERSION}"
       - name: Install dependencies
         run: make dev
       - name: Run all tests, linting and baselines
         if: ${{ !inputs.skip_code_quality }}
         run: make pr
       - name: Bump package version
-        run: poetry version ${RELEASE_VERSION}
+        run: poetry version "${RELEASE_VERSION}"
       - name: Build python package and wheel
         if: ${{ !inputs.skip_pypi }}
         run: poetry build
@@ -101,7 +101,7 @@ jobs:
           role-to-assume: ${{ secrets.AWS_SAR_ROLE_ARN }}
       - name: publish lambda layer in SAR by triggering the internal codepipeline
         run: |
-          aws ssm put-parameter --name "powertools-python-release-version" --value $RELEASE_VERSION --overwrite
+          aws ssm put-parameter --name "powertools-python-release-version" --value "$RELEASE_VERSION" --overwrite
           aws codepipeline start-pipeline-execution --name ${{ secrets.AWS_SAR_PIPELINE_NAME }}
 
   changelog:
@@ -115,47 +115,11 @@ jobs:
     permissions:
       contents: write
       pages: write
-    runs-on: ubuntu-latest
-    env:
-      RELEASE_VERSION: ${{ needs.release.outputs.RELEASE_VERSION }}
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Git client setup and refresh tip
-        run: |
-          git config user.name "Release bot"
-          git config user.email "aws-devax-open-source@amazon.com"
-          git config pull.rebase true
-          git config remote.origin.url >&- || git remote add origin https://github.com/$origin # Git Detached mode (release notes) doesn't have origin
-          git pull origin $BRANCH
-      - name: Install poetry
-        run: pipx install poetry
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.8"
-          cache: "poetry"
-      - name: Install dependencies
-        run: make dev
-      - name: Build docs website and API reference
-        run: |
-          make release-docs VERSION=${RELEASE_VERSION} ALIAS="latest"
-          poetry run mike set-default --push latest
-      - name: Release API docs to release version
-        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./api
-          keep_files: true
-          destination_dir: ${{ env.RELEASE_VERSION }}/api
-      - name: Release API docs to latest
-        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./api
-          keep_files: true
-          destination_dir: latest/api
+    uses: ./.github/workflows/reusable_publish_docs.yml
+    with:
+      version: ${{ needs.release.outputs.RELEASE_VERSION }}
+      alias: latest
+      detached_mode: true
 
   post_release:
     needs: release

.github/workflows/python_build.yml

@@ -10,6 +10,7 @@ on:
       - "mypy.ini"
     branches:
       - develop
+      - v2
   push:
     paths:
       - "aws_lambda_powertools/**"
@@ -19,6 +20,7 @@ on:
       - "mypy.ini"
     branches:
       - develop
+      - v2
 
 jobs:
   build:
@@ -54,7 +56,5 @@ jobs:
         uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # 3.1.0
         with:
           file: ./coverage.xml
-          # flags: unittests
           env_vars: PYTHON
           name: aws-lambda-powertools-python-codecov
-          # fail_ci_if_error: true  # failing more consistently making CI unreliable despite all tests above passing