Skip to content

chore(docs): update roadmap, labels, and issue templates #1632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ body:
- Metrics
- Parameters
- Idempotency
- JMESPath
- Batch Processing
- Validation
- Parser
- Other
- type: textarea
id: suggestion
Expand Down
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ body:
- Metrics
- Parameters
- Idempotency
- JMESPath
- Batch Processing
- Validation
- Parser
- Other
validations:
required: true
Expand Down
3 changes: 2 additions & 1 deletion .github/semantic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ scopes:
- idempotency
- commons
- parser
- validator
- jmespath
- validation
- batch
- layers
- ci
Expand Down
4 changes: 4 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ These are the most common labels used by maintainers to triage issues, pull requ
| area/idempotency | Items related to the Idempotency Utility | PR automation |
| area/parameters | Items related to the Parameters Utility | PR automation |
| area/commons | Items related to the Commons Utility | PR automation |
| area/jmespath | Items related to the JMESPath Utility | PR automation |
| area/validation | Items related to the Validation Utility | PR automation |
| area/batch | Items related to the Batch Processing Utility | PR automation |
| area/parser | Items related to the Parser Utility | PR automation |
| area/automation | Items related to automation like GitHub workflows or CI/CD | PR automation |
| area/layers | Items related to the Lambda Layers pipeline | PR automation |
| size/XS | PRs between 0-9 LOC | PR automation |
Expand Down
21 changes: 11 additions & 10 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Themes are key activities maintainers are focusing on, besides bug reports. Thes

We want to close the gap between this version of Powertools for AWS Lambda and the [Python version](https://github.com/aws-powertools/powertools-lambda-python). This means that in the fullness of time, we want to have the same or equivalent features in both versions.

In the first half of 2023 we have released the [Parameters utility](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/10), and are working on Idempotency. We are currently running a private beta for Idempotency, and plan on releasing the [public beta around July 2023](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/7) at the latest.
In the first half of 2023 we have released the [Parameters utility](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/10), then in July we have released public betas for [Idempotency](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/7) and [Batch Processing](https://github.com/aws-powertools/powertools-lambda-typescript/milestone/13). We are eager to hear your feedback on these new features, so please try them out and let us know what you think!

For the second half of 2023, we are considering implementing one or more of the following utilities (in no particular order):
- Batch Processing (Status: [RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1082))
- Validation (Status: [RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/508))
- Parser (Status: [RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1334))
- Event Handler (Status: [RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/413))
For the remaining of 2023, we are considering implementing one or more of the following utilities (in no particular order):

* Validation (Status: [RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/508))
* Parser (Status: [RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1334))
* Event Handler (Status: [RFC](https://github.com/aws-powertools/powertools-lambda-typescript/issues/413))

If any of these utilities are important to you, please let us know by upvoting the issue, leaving a comment under the RFCs, or by joining the discussion in our [Discord community](https://discord.gg/B8zZKbbyET){target="_blank"}.

Expand All @@ -29,17 +29,18 @@ If any of these utilities are important to you, please let us know by upvoting t
Over the past year, we have gathered a number of feature requests and improvements that we want to implement but that are not backwards compatible with the current API surface. We are planning to release a new major version of the library by the end of 2023, which will include some of these changes.

The following are some of the changes we are considering:
- **ES Modules support ([#521](https://github.com/aws-powertools/powertools-lambda-typescript/issues/521))** - Thanks to the work of the community we have been able to validate the feasibility of dual support for CommonJS and ES Modules. We are currently working on a plan to implement this.
- **TypeScript 5.x support ([#1375](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1375))** - This new version of TypeScript brings breaking changes to the experimental decorators API, which we use in our core utilities. We need to investigate the impact of this change and how to best support it.
- **Support for 3rd party observability providers ([#1500](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1500))** - Many of our customers would like to use Powertools for AWS to send logs, traces, and metrics to providers other than Amazon CloudWatch. At the moment we are investigating the feasibility of this for the Logger utility, while the Python version of Powertools for AWS Lambda is considering this also for Tracer and Metrics.

* **ES Modules support ([#521](https://github.com/aws-powertools/powertools-lambda-typescript/issues/521))** - Thanks to the work of the community we have been able to validate the feasibility of dual support for CommonJS and ES Modules. We are currently working on a plan to implement this.
* **TypeScript 5.x support ([#1375](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1375))** - This new version of TypeScript brings breaking changes to the experimental decorators API, which we use in our core utilities. We need to investigate the impact of this change and how to best support it.
* **Support for 3rd party observability providers ([#1500](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1500))** - Many of our customers would like to use Powertools for AWS to send logs, traces, and metrics to providers other than Amazon CloudWatch. At the moment we are investigating the feasibility of this for the Logger utility, while the Python version of Powertools for AWS Lambda is considering this also for Tracer and Metrics.

We have not yet decided on the final list of features that will be included in this release, if you have any suggestions please let us know by commenting on [this discussion](https://github.com/aws-powertools/powertools-lambda-typescript/discussions/1269) or upvoting existing suggestions.

### Improve operational excellence

We continue to work on increasing operational excellence to remove as much undifferentiated heavylifting for maintainers, so that we can focus on delivering features that help you.

This means improving our automation workflows, and project management, and test coverage.
This means improving our automation workflows, project management, and test coverage.

## Roadmap status definition

Expand Down