Merge pull request #38 from aws-samples/develop

maintenance: merging latest v1 changes with main

Author: sliedig

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+* @aws-samples/aws-serverless-developer-experience-workshop-py

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,58 @@
+name: Bug report
+description: Report a reproducible bug to help us improve
+title: "Bug: TITLE"
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for submitting a bug report. Please add as much information as possible to help us reproduce, and remove any potential sensitive data.
+  - type: textarea
+    id: expected_behaviour
+    attributes:
+      label: Expected Behaviour
+      description: Please share details on the behaviour you expected
+    validations:
+      required: true
+  - type: textarea
+    id: current_behaviour
+    attributes:
+      label: Current Behaviour
+      description: Please share details on the current issue
+    validations:
+      required: true
+  - type: textarea
+    id: code_snippet
+    attributes:
+      label: Code snippet
+      description: Please share a code snippet to help us reproduce the issue
+      render: csharp
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Possible Solution
+      description: If known, please suggest a potential resolution
+    validations:
+      required: false
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: Please share how we might be able to reproduce this issue
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Debugging logs
+      description: If available, please share debugging logs
+      render: csharp
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        --
+        **Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

.github/ISSUE_TEMPLATE/maintenance.yml

@@ -0,0 +1,37 @@
+name: Maintenance
+description: Suggest an activity to help address tech debt, governance, and anything internal
+title: "Maintenance: TITLE"
+labels: ["internal", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to help us improve operational excellence.
+
+        *Future readers*: Please react with 👍 and your use case to help us understand customer demand.
+  - type: textarea
+    id: activity
+    attributes:
+      label: Summary
+      description: Please provide an overview in one or two paragraphs
+    validations:
+      required: true
+  - type: textarea
+    id: importance
+    attributes:
+      label: Why is this needed?
+      description: Please help us understand the value so we can prioritize it accordingly
+    validations:
+      required: true
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Solution
+      description: If available, please share what a good solution would look like
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        ---
+        **Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+**Issue number:**
+
+## Summary
+
+### Changes
+
+> Please provide a summary of what's being changed
+
+### User experience
+
+> Please share what the user experience looks like before and after this change
+
+## Checklist
+
+Please leave checklist items unchecked if they do not apply to your change.
+
+* [ ] I have performed a self-review of this change
+* [ ] Changes have been tested
+* [ ] Changes are documented
+* [ ] PR title follows [conventional commit semantics](https://github.com/aws-samples/aws-serverless-developer-experience-workshop-python/blob/develop/.github/semantic.yml)
+
+## Acknowledgment
+
+By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
+
+**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

.github/auto_assign.yml

@@ -0,0 +1,26 @@
+# Set to true to add reviewers to pull requests
+addReviewers: true
+
+# Set to true to add assignees to pull requests
+addAssignees: true
+
+# A list of reviewers to be added to pull requests (GitHub user name)
+reviewers:
+  - igorlg
+
+# A number of reviewers added to the pull request
+# Set 0 to add all the reviewers (default: 0)
+numberOfReviewers: 1
+
+# A list of assignees, overrides reviewers if set
+# assignees:
+#   - sliedig
+
+# A number of assignees to add to the pull request
+# Set to 0 to add all of the assignees.
+# Uses numberOfReviewers if unset.
+numberOfAssignees: 0
+
+# A list of keywords to be skipped the process that add reviewers if pull requests include it
+# skipKeywords:
+#   - wip

.github/boring-cyborg.yml

@@ -0,0 +1,32 @@
+##### Labeler ##########################################################################################################
+labelPRBasedOnFilePath:
+  service/contracts:
+    - Unicorn.Contracts
+  service/properties:
+    - Unicorn.Properties
+  service/web:
+    - Unicorn.Web
+
+  internal:
+    - .github/*
+    - .github/**/*
+    - .chglog/*
+    - .flake8
+    - .gitignore
+    - .pre-commit-config.yaml
+    - Makefile
+    - CONTRIBUTING.md
+    - CODE_OF_CONDUCT.md
+    - LICENSE
+
+##### Greetings ########################################################################################################
+firstPRWelcomeComment: >
+  Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
+
+# 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!
+
+# Comment to be posted to on first time issues
+firstIssueWelcomeComment: >
+  Thanks for opening your first issue here! We'll come back to you as soon as we can.

.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/constants.js

@@ -0,0 +1,36 @@
+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_BLOCK_MISSING_LICENSE_AGREEMENT": "need-license-agreement-acknowledge",
+
+    /** @type {string} */
+    "LABEL_PENDING_RELEASE": "pending-release",
+
+    /** @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/enforce_acknowledgment.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]
+        })
+    }
+}