Merge branch 'main' into docs/base-documentation

Author: dreamorosi

.github/workflows/auto-merge.yml

@@ -0,0 +1,68 @@
+name: Dependabot PR auto-merge
+
+on:
+  workflow_run:
+    workflows: [on-pull-request]
+    types: ["completed"]
+
+jobs:
+  auto-merge:
+    name: Auto-merge
+    runs-on: ubuntu-latest
+    # Run this only when the previous workflow was successfull & the initial actor was dependabot
+    if: ${{ github.event.workflow_run.conclusion == 'success' && github.actor == 'dependabot[bot]' }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Download PR artifact
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const fs = require('fs');
+
+            // Get all artifacts
+            const artifacts = await github.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: ${{github.event.workflow_run.id }},
+            });
+            
+            // Identify the artifact of the PR
+            const matchArtifact = artifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "pr"
+            })[0];
+            
+            // Download the actual artifact
+            const download = await github.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            
+            // Write it to disk
+            fs.writeFileSync('${{github.workspace}}/pr.zip', Buffer.from(download.data));
+      - name: Unzip artifact
+        run: unzip pr.zip
+      - name: Merge PR
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const fs = require('fs');
+            const pullNumber = Number(fs.readFileSync('./NR'));
+            
+            // Create a review
+            github.pulls.createReview({
+              owner: context.payload.repository.owner.login,
+              repo: context.payload.repository.name,
+              pull_number: pullNumber,
+              event: 'APPROVE'
+            })
+            
+            // Merge PR
+            github.pulls.merge({
+              owner: context.payload.repository.owner.login,
+              repo: context.payload.repository.name,
+              pull_number: pullNumber,
+              merge_method: 'squash'
+            })
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/on-pull-request.yml

@@ -24,8 +24,12 @@ jobs:
       - name: Collate Coverage Reports
         if: ${{ github.actor != 'dependabot[bot]' }}
         run: |
-          mkdir -p coverage
           for d in ./packages/*/ ; do
+              mkdir -p coverage
+              if [[ ! -f coverage/lcov.info ]]
+              then
+                  continue
+              fi
               filename="$d""coverage/lcov.info"
               targetSource="SF:""$d""src"
               sed "s|SF:src|$targetSource|g" $filename >> coverage/lcov.info

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lerna-lint

.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run test

CONTRIBUTING.md

@@ -28,20 +28,22 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
 1. You are working against the latest source on the **main** branch.
 2. You check existing open, and recently merged pull requests to make sure someone else hasn't addressed the problem already.
 3. You open an [RFC issue](https://github.com/awslabs/aws-lambda-powertools-typescript/issues/new?assignees=&labels=RFC%2C+triage&template=rfc.md&title=RFC%3A+) to discuss any significant work - we would hate for your time to be wasted.
+4. You lint and test the code. When you've setup the repository with `npm run init-environment`, pre-commit and push-hooks will automatically lint and test the code. Pull request builds will run the same checks as well.
 
 ### Dev setup
 
 To send us a pull request, please follow these steps:
 
 1. Fork the repository.
 2. Install dependencies: `npm install`
-3. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling`
-4. Run all tests, and code baseline checks: `npm run test`
-5. Commit to your fork using clear commit messages.
-6. Send us a pull request with a [conventional semantic title](https://github.com/awslabs/aws-lambda-powertools-typescript/pull/67), and answering any default questions in the pull request interface.
-7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
-
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
+3. Prepare utilities like commit hooks: `npm run init-environment`
+4. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling`
+5. Run all tests, and code baseline checks: `npm run test`
+6. Commit to your fork using clear commit messages.
+7. Send us a pull request with a [conventional semantic title](https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/.github/semantic.yml), and answering any default questions in the pull request interface. [Here's an example](https://github.com/awslabs/aws-lambda-powertools-python/pull/67).
+8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+GitHub provides an additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
 #### Local documentation