From 50f9806aabb9cb14ffbfcb22b50e6d0162b8812b Mon Sep 17 00:00:00 2001 From: Alexander Melnyk Date: Wed, 20 Sep 2023 12:33:19 +0200 Subject: [PATCH 1/5] docs: remove beta warning from batch and idempotency readme --- packages/batch/README.md | 6 ------ packages/idempotency/README.md | 5 ----- 2 files changed, 11 deletions(-) diff --git a/packages/batch/README.md b/packages/batch/README.md index ff26800107..622297d37c 100644 --- a/packages/batch/README.md +++ b/packages/batch/README.md @@ -1,11 +1,5 @@ # Powertools for AWS Lambda (TypeScript) - Batch Processing Utility - -| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️ | -| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**.. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/14) we might introduce significant breaking changes and improvements in response to customers feedback. | _ | - - 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). You can use the package in both TypeScript and JavaScript code bases. diff --git a/packages/idempotency/README.md b/packages/idempotency/README.md index 27abb05d24..99e8f812e8 100644 --- a/packages/idempotency/README.md +++ b/packages/idempotency/README.md @@ -1,11 +1,6 @@ # Powertools for AWS Lambda (TypeScript) - Idempotency Utility -| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️ | -| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**.. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/10) we might introduce significant breaking changes and improvements in response to customers feedback. | _ | - - 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). You can use the package in both TypeScript and JavaScript code bases. From b0e8f79e866867d596028cd4bc1d55bea6435835 Mon Sep 17 00:00:00 2001 From: Alexander Melnyk Date: Wed, 20 Sep 2023 13:46:28 +0200 Subject: [PATCH 2/5] remove beta flag in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0363e5c104..6eff246381 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,8 @@ You can use the library in both TypeScript and JavaScript code bases. * **[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 (beta)](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 (beta)](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. +* **[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 371526d7ddae2c871ecc55e3cfca2e863016308b Mon Sep 17 00:00:00 2001 From: Alexander Melnyk Date: Wed, 20 Sep 2023 13:51:53 +0200 Subject: [PATCH 3/5] add remove parameters beta flag in main doc page, add idempotency and batch --- docs/index.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 897b6407f5..220c9b0146 100644 --- a/docs/index.md +++ b/docs/index.md @@ -282,12 +282,14 @@ If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly Core utilities such as Tracing, Logging, and Metrics will be available across all Powertools for AWS Lambda languages. Additional utilities are subjective to each language ecosystem and customer demand. -| Utility | Description | -| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions | -| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details | -| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) | -| [Parameters (beta)](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB | +| Utility | Description | +|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions | +| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details | +| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) | +| [Parameters](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB | +| [Idempotency](./utilities/idempotency.md) | Convert your Lambda functions into idempotent operations which are safe to retry. | +| [Batch Processing](./utilities/batch.md) | Handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. | ## Environment variables From dc3a22d8dd6f9849a5f909463b1f1d4051eacf7d Mon Sep 17 00:00:00 2001 From: Alexander Melnyk Date: Wed, 20 Sep 2023 13:59:30 +0200 Subject: [PATCH 4/5] add links in commons README --- packages/commons/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/commons/README.md b/packages/commons/README.md index cfef383eb4..1e19a9a3e0 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -32,6 +32,8 @@ You can use the library in both TypeScript and JavaScript code bases. * **[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, Secrets Manager, AppConfig, and 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/)** - Utilities to process batches of events from Kinesis, SQS, DynamoDB Streams. ## Getting started From 41f1ef730560cacddf0246ae49dfd8a7a60092d6 Mon Sep 17 00:00:00 2001 From: Alexander Melnyk Date: Wed, 20 Sep 2023 14:01:04 +0200 Subject: [PATCH 5/5] consistent message --- docs/index.md | 16 ++++++++-------- packages/commons/README.md | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index 220c9b0146..55c581ee7d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -282,14 +282,14 @@ If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly Core utilities such as Tracing, Logging, and Metrics will be available across all Powertools for AWS Lambda languages. Additional utilities are subjective to each language ecosystem and customer demand. -| Utility | Description | -|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| -| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions | -| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details | -| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) | -| [Parameters](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB | -| [Idempotency](./utilities/idempotency.md) | Convert your Lambda functions into idempotent operations which are safe to retry. | -| [Batch Processing](./utilities/batch.md) | Handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. | +| Utility | Description | +|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions | +| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details | +| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) | +| [Parameters](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB | +| [Idempotency](./utilities/idempotency.md) | Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content. | +| [Batch Processing](./utilities/batch.md) | Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. | ## Environment variables diff --git a/packages/commons/README.md b/packages/commons/README.md index 1e19a9a3e0..29241216a8 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -33,7 +33,7 @@ You can use the library in both TypeScript and JavaScript code bases. * **[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, Secrets Manager, AppConfig, and 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/)** - Utilities to process batches of events from Kinesis, SQS, DynamoDB Streams. +* **[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