From 4ee7eb14083bb9501bb68df4b95cf0125eb23bce Mon Sep 17 00:00:00 2001 From: Henrique Graca <999396+hjgraca@users.noreply.github.com> Date: Wed, 14 Feb 2024 15:54:56 +0000 Subject: [PATCH 1/6] Update README - add badges --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0007981387..d13964911a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # Powertools for AWS Lambda (TypeScript) -[![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET)](https://discord.gg/B8zZKbbyET) +[![Build](https://github.com/aws-powertools/powertools-lambda-typescript/actions/workflows/pr-run-linting-check-and-unit-tests.yml/badge.svg)]([https://github.com/aws-powertools/powertools-lambda-typescript/actions/workflows/pr-run-linting-check-and-unit-tests.yml]) +![NodeSupport](https://img.shields.io/static/v1?label=node&message=%2016|%2018|%2020&color=green?style=flat-square&logo=node) +![GitHub Release](https://img.shields.io/github/v/release/aws-powertools/powertools-lambda-typescript?style=flat-square) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=aws-powertools_powertools-lambda-typescript&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=aws-powertools_powertools-lambda-typescript) +[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=aws-powertools_powertools-lambda-typescript&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=aws-powertools_powertools-lambda-typescript) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-typescript/badge)](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-typescript) +[![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET?style=flat-square)](https://discord.gg/B8zZKbbyET) Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda/typescript/latest/#features). @@ -31,12 +37,24 @@ You can use the library in both TypeScript and JavaScript code bases. ## Features -* **[Tracer](https://docs.powertools.aws.dev/lambda/typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions -* **[Logger](https://docs.powertools.aws.dev/lambda/typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context -* **[Metrics](https://docs.powertools.aws.dev/lambda/typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) -* **[Parameters](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parameters/)** - High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB -* **[Idempotency](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/idempotency/)** - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content -* **[Batch Processing](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/batch/)** - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. +* **[Tracer](https://docs.powertools.aws.dev/lambda/typescript/latest/core/tracer/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Ftracer.svg?style=flat-square +)](https://www.npmjs.com/package/@aws-lambda-powertools/tracer) + * Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions +* **[Logger](https://docs.powertools.aws.dev/lambda/typescript/latest/core/logger/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Flogger.svg?style=flat-square +)](https://www.npmjs.com/package/@aws-lambda-powertools/logger) + * Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context +* **[Metrics](https://docs.powertools.aws.dev/lambda/typescript/latest/core/metrics/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fmetrics.svg?style=flat-square +)](https://www.npmjs.com/package/@aws-lambda-powertools/metrics) + * Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) +* **[Parameters](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parameters/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fparameters.svg?style=flat-square +)](https://www.npmjs.com/package/@aws-lambda-powertools/parameters) + * High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB +* **[Idempotency](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/idempotency/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fidempotency.svg?style=flat-square +)](https://www.npmjs.com/package/@aws-lambda-powertools/idempotency) + * Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content +* **[Batch Processing](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/batch/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fbatch.svg?style=flat-square +)](https://www.npmjs.com/package/@aws-lambda-powertools/batch) + * Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. ## Getting started From 8d1b229458e089b3b0c4a41f5945b1771658894a Mon Sep 17 00:00:00 2001 From: Henrique Graca <999396+hjgraca@users.noreply.github.com> Date: Wed, 14 Feb 2024 17:20:52 +0000 Subject: [PATCH 2/6] move utility badges to the top --- README.md | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index d13964911a..21588f33d5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=aws-powertools_powertools-lambda-typescript&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=aws-powertools_powertools-lambda-typescript) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=aws-powertools_powertools-lambda-typescript&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=aws-powertools_powertools-lambda-typescript) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-typescript/badge)](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-typescript) +![NPM Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Ftracer?style=flat-square&label=Tracer) +![NPM Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Flogger?style=flat-square&label=Logger) +![NPM Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fmetrics?style=flat-square&label=Metrics) [![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET?style=flat-square)](https://discord.gg/B8zZKbbyET) Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda/typescript/latest/#features). @@ -37,24 +40,12 @@ You can use the library in both TypeScript and JavaScript code bases. ## Features -* **[Tracer](https://docs.powertools.aws.dev/lambda/typescript/latest/core/tracer/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Ftracer.svg?style=flat-square -)](https://www.npmjs.com/package/@aws-lambda-powertools/tracer) - * Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions -* **[Logger](https://docs.powertools.aws.dev/lambda/typescript/latest/core/logger/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Flogger.svg?style=flat-square -)](https://www.npmjs.com/package/@aws-lambda-powertools/logger) - * Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context -* **[Metrics](https://docs.powertools.aws.dev/lambda/typescript/latest/core/metrics/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fmetrics.svg?style=flat-square -)](https://www.npmjs.com/package/@aws-lambda-powertools/metrics) - * Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) -* **[Parameters](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parameters/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fparameters.svg?style=flat-square -)](https://www.npmjs.com/package/@aws-lambda-powertools/parameters) - * High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB -* **[Idempotency](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/idempotency/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fidempotency.svg?style=flat-square -)](https://www.npmjs.com/package/@aws-lambda-powertools/idempotency) - * Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content -* **[Batch Processing](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/batch/)** [![Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fbatch.svg?style=flat-square -)](https://www.npmjs.com/package/@aws-lambda-powertools/batch) - * Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. +* **[Tracer](https://docs.powertools.aws.dev/lambda/typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions +* **[Logger](https://docs.powertools.aws.dev/lambda/typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context +* **[Metrics](https://docs.powertools.aws.dev/lambda/typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) +* **[Parameters](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parameters/)** - High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB +* **[Idempotency](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/idempotency/)** - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content +* **[Batch Processing](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/batch/)** - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. ## Getting started From 01d3dc4f0e25edbf1cc86e34b09e1a9fbc4b281d Mon Sep 17 00:00:00 2001 From: Henrique Graca <999396+hjgraca@users.noreply.github.com> Date: Wed, 14 Feb 2024 17:23:25 +0000 Subject: [PATCH 3/6] Rename workflow from "On PR code update" to "Build" Rename workflow from "On PR code update" to "Build" --- .github/workflows/pr-run-linting-check-and-unit-tests.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pr-run-linting-check-and-unit-tests.yml b/.github/workflows/pr-run-linting-check-and-unit-tests.yml index 2f8da3bb36..05bb84e467 100644 --- a/.github/workflows/pr-run-linting-check-and-unit-tests.yml +++ b/.github/workflows/pr-run-linting-check-and-unit-tests.yml @@ -1,4 +1,4 @@ -name: On PR code update +name: Build on: pull_request: @@ -9,4 +9,4 @@ permissions: jobs: run-unit-tests: - uses: ./.github/workflows/reusable-run-linting-check-and-unit-tests.yml \ No newline at end of file + uses: ./.github/workflows/reusable-run-linting-check-and-unit-tests.yml From 57c5b954353231615c5513c3b66b92e80cab2a55 Mon Sep 17 00:00:00 2001 From: Henrique Graca <999396+hjgraca@users.noreply.github.com> Date: Thu, 15 Feb 2024 10:26:27 +0000 Subject: [PATCH 4/6] Remove download badges --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 21588f33d5..0f38214c66 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,6 @@ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=aws-powertools_powertools-lambda-typescript&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=aws-powertools_powertools-lambda-typescript) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=aws-powertools_powertools-lambda-typescript&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=aws-powertools_powertools-lambda-typescript) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-typescript/badge)](https://api.securityscorecards.dev/projects/github.com/aws-powertools/powertools-lambda-typescript) -![NPM Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Ftracer?style=flat-square&label=Tracer) -![NPM Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Flogger?style=flat-square&label=Logger) -![NPM Downloads](https://img.shields.io/npm/dw/%40aws-lambda-powertools%2Fmetrics?style=flat-square&label=Metrics) [![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET?style=flat-square)](https://discord.gg/B8zZKbbyET) Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda/typescript/latest/#features). From 8ce56944fd477a7c41a7cf7a5222d18ae231466d Mon Sep 17 00:00:00 2001 From: Henrique Graca <999396+hjgraca@users.noreply.github.com> Date: Thu, 15 Feb 2024 11:21:02 +0000 Subject: [PATCH 5/6] remove build badge --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 0f38214c66..71a3bb7613 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Powertools for AWS Lambda (TypeScript) -[![Build](https://github.com/aws-powertools/powertools-lambda-typescript/actions/workflows/pr-run-linting-check-and-unit-tests.yml/badge.svg)]([https://github.com/aws-powertools/powertools-lambda-typescript/actions/workflows/pr-run-linting-check-and-unit-tests.yml]) ![NodeSupport](https://img.shields.io/static/v1?label=node&message=%2016|%2018|%2020&color=green?style=flat-square&logo=node) ![GitHub Release](https://img.shields.io/github/v/release/aws-powertools/powertools-lambda-typescript?style=flat-square) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=aws-powertools_powertools-lambda-typescript&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=aws-powertools_powertools-lambda-typescript) From 4f47ccd3d66556ee9882c6a372912438771ed513 Mon Sep 17 00:00:00 2001 From: Henrique Graca <999396+hjgraca@users.noreply.github.com> Date: Thu, 15 Feb 2024 11:23:51 +0000 Subject: [PATCH 6/6] undo rename --- .github/workflows/pr-run-linting-check-and-unit-tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pr-run-linting-check-and-unit-tests.yml b/.github/workflows/pr-run-linting-check-and-unit-tests.yml index 05bb84e467..7c87fc8abf 100644 --- a/.github/workflows/pr-run-linting-check-and-unit-tests.yml +++ b/.github/workflows/pr-run-linting-check-and-unit-tests.yml @@ -1,4 +1,4 @@ -name: Build +name: On PR code update on: pull_request: