test(cicd): Fix/release

.eslintrc.js

@@ -1,63 +1,77 @@
 module.exports = {
   env: {
-    'browser': false,
-    'es2020': true,
-    'jest': true,
-    'node': true,
+    browser: false,
+    es2020: true,
+    jest: true,
+    node: true,
   },
-  extends: [
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended'
-  ],
+  extends: ['plugin:@typescript-eslint/eslint-recommended', 'plugin:@typescript-eslint/recommended'],
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint'],
+  settings: {
+    'import/resolver': {
+      node: {},
+      typescript: {
+        project: './tsconfig.es.json',
+        alwaysTryTypes: true,
+      },
+    },
+  },
   rules: {
     '@typescript-eslint/ban-ts-ignore': ['off'],
     '@typescript-eslint/camelcase': ['off'],
-    '@typescript-eslint/explicit-function-return-type': [ 'error', { 'allowExpressions': true } ],
+    '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
     '@typescript-eslint/explicit-member-accessibility': 'error',
-    '@typescript-eslint/indent': [ 'error', 2, { 'SwitchCase': 1 } ],
+    '@typescript-eslint/indent': ['error', 2, { SwitchCase: 1 }],
     '@typescript-eslint/interface-name-prefix': ['off'],
-    '@typescript-eslint/member-delimiter-style': [ 'error', { 'multiline': { 'delimiter': 'none' } } ],
-    '@typescript-eslint/member-ordering': [ 'error', {
-      'default': { 'memberTypes': [
-        'signature',
-        'public-field', // = ["public-static-field", "public-instance-field"]
-        'protected-field', // = ["protected-static-field", "protected-instance-field"]
-        'private-field', // = ["private-static-field", "private-instance-field"]
-        'constructor',
-        'public-method', // = ["public-static-method", "public-instance-method"]
-        'protected-method', // = ["protected-static-method", "protected-instance-method"]
-        'private-method' // = ["private-static-method", "private-instance-method"]
-      ] ,
-      'order': 'alphabetically' }
-    } ],
+    '@typescript-eslint/member-delimiter-style': ['error', { multiline: { delimiter: 'none' } }],
+    '@typescript-eslint/member-ordering': [
+      'error',
+      {
+        default: {
+          memberTypes: [
+            'signature',
+            'public-field', // = ["public-static-field", "public-instance-field"]
+            'protected-field', // = ["protected-static-field", "protected-instance-field"]
+            'private-field', // = ["private-static-field", "private-instance-field"]
+            'constructor',
+            'public-method', // = ["public-static-method", "public-instance-method"]
+            'protected-method', // = ["protected-static-method", "protected-instance-method"]
+            'private-method', // = ["private-static-method", "private-instance-method"]
+          ],
+          order: 'alphabetically',
+        },
+      },
+    ],
     '@typescript-eslint/no-explicit-any': 'error',
     '@typescript-eslint/no-inferrable-types': ['off'],
-    '@typescript-eslint/no-unused-vars': [ 'error', { 'argsIgnorePattern': '^_' } ],
+    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
     '@typescript-eslint/no-use-before-define': ['off'],
-    '@typescript-eslint/semi': [ 'error', 'always' ],
-    'array-bracket-spacing': [ 'error', 'always', { 'singleValue': false } ],
-    'arrow-body-style': [ 'error', 'as-needed' ],
-    'computed-property-spacing': [ 'error', 'never' ],
-    'func-style': [ 'warn', 'expression' ],
-    'indent': [ 'error', 2, { 'SwitchCase': 1 } ],
+    '@typescript-eslint/semi': ['error', 'always'],
+    'array-bracket-spacing': ['error', 'always', { singleValue: false }],
+    'arrow-body-style': ['error', 'as-needed'],
+    'computed-property-spacing': ['error', 'never'],
+    'func-style': ['warn', 'expression'],
+    indent: ['error', 2, { SwitchCase: 1 }],
     'keyword-spacing': 'error',
     'newline-before-return': 2,
     'no-console': 0,
-    'no-multi-spaces': [ 'error', { 'ignoreEOLComments': false } ],
-    'no-multiple-empty-lines': [ 'error', { 'max': 1, 'maxBOF': 0 } ],
+    'no-multi-spaces': ['error', { ignoreEOLComments: false }],
+    'no-multiple-empty-lines': ['error', { max: 1, maxBOF: 0 }],
     'no-throw-literal': 'error',
-    'object-curly-spacing': [ 'error', 'always' ],
+    'object-curly-spacing': ['error', 'always'],
     'prefer-arrow-callback': 'error',
-    'quotes': [ 'error', 'single', { 'allowTemplateLiterals': true } ],
-    'semi': [ 'error', 'always' ],
-    'sort-imports': [ 'error', {
-      'allowSeparatedGroups': true,
-      'ignoreCase': true,
-      'ignoreDeclarationSort': false,
-      'ignoreMemberSort': true,
-      'memberSyntaxSortOrder': [ 'all', 'single', 'multiple', 'none' ]
-    } ]
-  }
-};
+    quotes: ['error', 'single', { allowTemplateLiterals: true }],
+    semi: ['error', 'always'],
+    'sort-imports': [
+      'error',
+      {
+        allowSeparatedGroups: true,
+        ignoreCase: true,
+        ignoreDeclarationSort: false,
+        ignoreMemberSort: true,
+        memberSyntaxSortOrder: ['all', 'single', 'multiple', 'none'],
+      },
+    ],
+  },
+};

.github/workflows/on-docs-change.yml

@@ -0,0 +1,55 @@
+name: Auto publish docs to version "develop"
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - 'mkdocs.yml'
+      - '.github/workflows/on-docs-change.yml'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v2.3.1
+        with:
+          python-version: '3.8'
+      - name: Set up NodeJS
+        uses: actions/setup-node@v2
+        with:
+          node-version: '17.2'
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip 
+          pip install mike==1.1.2 mkdocs-material==8.0.5 mkdocs-git-revision-date-plugin==0.3.1
+          npm ci
+      - name: Setup doc deploy
+        run: |
+          git config --global user.name Docs deploy
+          git config --global user.email docs@dummy.bot.com
+      - name: Build mkdocs site in 'gh-pages' branch and push
+        run: |
+          rm -rf site
+          VERSION="develop"
+          ALIAS="stage"
+          mkdocs build
+          mike deploy --push --update-aliases "$VERSION" "$ALIAS"
+      - name: Build API documentation site 
+        run: |
+          rm -rf api
+          npm run docs-generateApiDoc
+      - name: Deploy API documentation site (copy to "gh-pages" branch inside the version folder)
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./api
+          keep_files: true
+          destination_dir: develop/api 

.github/workflows/on-push.yml

@@ -5,7 +5,6 @@ on:
 jobs:
   on_push:
     runs-on: ubuntu-latest
-    if: ${{ github.event_name != 'pull_request' }}
     env:
       NODE_ENV: dev
     steps:
@@ -14,11 +13,34 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: '14'
+      - name: "Setup npm"
+        run: |
+          npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
       - name: Install packages
         run: |
           npm ci
           npm run lerna-ci
       - name: Run lint
         run: npm run lerna-lint
       - name: Run tests
-        run: npm run lerna-test
+        run: npm run lerna-test
+      - name: Collate Coverage Reports
+        if: ${{ github.actor != 'dependabot[bot]' }}
+        run: |
+          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
+          done
+      - name: Report Coverage
+        #Dependabot user will only have read-only perms, so don't try to report coverage
+        if: ${{ github.actor != 'dependabot[bot]' }}
+        uses: romeovs/lcov-reporter-action@v0.3.1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          lcov-file: ./coverage/lcov.info

.github/workflows/on-release.yml

@@ -2,7 +2,7 @@ name: release
 on:
   push:
     branches:
-      - main
+      - chore/releaseFlow
   workflow_dispatch: {}
 jobs:
   publish:
@@ -43,20 +43,3 @@ jobs:
         fi
 
         npx lerna publish --no-verify-access from-git --yes
-
-  slack:
-    name: Publish to slack channel
-    needs: 
-      - publish
-    runs-on: ubuntu-latest
-    steps:
-      - name: publish latest release
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-        run: |
-          curl -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/${{ github.repository }}/releases/latest > release.json
-          VERSION=$( jq -r '.name' release.json )
-          CONTENT=$( jq -r '.body' release.json )
-          jq -n --arg version "$VERSION" --arg content "$CONTENT" '{"release-version": $version, "release-content": $content}' > body.json
-          curl --location --request POST $SLACK_WEBHOOK_URL \
-          --header 'Content-Type: application/json' --data @body.json

.gitignore

@@ -29,4 +29,13 @@ coverage
 .DS_Store
 
 # Visual Studio Code
-.vscode
+.vscode
+
+# Python virtual environments (for running mkdocs locally)
+venv
+
+# Static documentation site generated by Mkdocs
+site
+
+# Generated API documentation (from TypeDoc)
+/api

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for changes and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+## 0.1.0
+
+### Features
+
+* **tracer:** beta release ([#91](https://github.com/awslabs/aws-lambda-powertools-python/issues/91))
+* **logger:** beta release ([#24](https://github.com/awslabs/aws-lambda-powertools-python/issues/24))
+* **metrics:** beta release ([#25](https://github.com/awslabs/aws-lambda-powertools-python/issues/25))

CONTRIBUTING.md

@@ -46,6 +46,17 @@ To send us a pull request, please follow these steps:
 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
+
+You might find useful to run both the documentation website and the API reference locally while contributing:
+
+* **API reference**: :construction:
+* **Docs website**:
+
+You can build and start a local docs website by running these two commands.
+  - `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
+  - `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
+
 ### Conventions
 
 Category | Convention

README.md

@@ -1,4 +1,4 @@
-# AWS Lambda Powertools (Typescript)
+# AWS Lambda Powertools (TypeScript)
 ![Tests](https://github.com/awslabs/aws-lambda-powertools-typescript/workflows/Test/badge.svg?branch=main)
 ## Testing
 The repo uses JEST tests, these can be run using
@@ -20,6 +20,11 @@ align them with the style guides. Please run this before creating a PR, and comm
 
 `npm run lerna-format`
 
+## Credits
+
+* Structured logging initial implementation from [aws-lambda-logging](https://gitlab.com/hadrien/aws_lambda_logging)
+* Powertools idea [DAZN Powertools](https://github.com/getndazn/dazn-lambda-powertools/)
+
 ## Security
 
 See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

docs/Dockerfile

@@ -0,0 +1,2 @@
+FROM squidfunk/mkdocs-material
+RUN pip install mkdocs-git-revision-date-plugin

docs/changelog.md

@@ -0,0 +1,2 @@
+[comment]: <> (Includes Changelog content entire file as a snippet)
+--8<-- "CHANGELOG.md"