You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| Alan Churley |[alan-churley](alan-churley)| CloudCall |
@@ -151,7 +150,7 @@ This allows you to have control over the commit message although it should match
151
150
152
151
Manage [labels](#labels), review issues regularly, and create new labels as needed by the project. Remove `triage` label when you're able to confirm the validity of a request, a bug can be reproduced, etc. Give priority to the original author for implementation, unless it is a sensitive task that is best handled by maintainers.
153
152
154
-
Make sure issues are assigned to our [board of activities](https://github.com/orgs/awslabs/projects/76/) and have the right [status](https://docs.powertools.aws.dev/lambda-typescript/latest/roadmap/#roadmap-status-definition).
153
+
Make sure issues are assigned to our [board of activities](https://github.com/orgs/aws-powertools/projects/7) and have the right [status](https://docs.powertools.aws.dev/lambda-typescript/latest/roadmap/#roadmap-status-definition).
155
154
156
155
Use our [labels](#labels) to signal good first issues to new community members, and to set expectation that this might need additional feedback from the author, other customers, experienced community members and/or maintainers.
157
156
@@ -188,6 +187,12 @@ When necessary, be upfront that the time to review, approve, and implement a RFC
188
187
189
188
An example of a successful RFC: [#447](https://github.com/aws-powertools/powertools-lambda-typescript/issues/447)
190
189
190
+
### Run end to end tests
191
+
192
+
E2E tests should be ran before every merge to `main` or manually via [run-e2e-tests workflow](https://github.com/aws-powertools/powertools-lambda-typescript/actions/workflows/run-e2e-tests.yml) before making a release.
193
+
194
+
To run locally, you need [AWS CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_prerequisites) and an [account bootstrapped](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html) (`cdk bootstrap`). With a default AWS CLI profile configured, or `AWS_PROFILE` environment variable set, run `npm run test:e2e -ws`. For more information on how the tests are structured, see [Integration Tests](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md#integration-tests).
195
+
191
196
### Releasing a new version
192
197
193
198
🚧 WIP 🚧
@@ -200,10 +205,6 @@ Make sure the `tag` field reflects the new version you're releasing, the target
200
205
201
206
You'll notice we group all changes based on their [labels](#labels) like `type/feature`, `type/bug`, `type/documentation`, etc.
202
207
203
-
**I spotted a typo or incorrect grouping - how do I fix it?**
204
-
205
-
Edit the respective PR title and update their [labels](#labels). Then run the [Release Drafter workflow](https://github.com/aws-powertools/powertools-lambda-typescript/actions/workflows/release-drafter.yml) to update the Draft release.
206
-
207
208
**All looking good, what's next?**
208
209
209
210
The best part comes now. Replace the placeholder `[Human readable summary of changes]` with what you'd like to communicate to customers what this release is all about. Rule of thumb: always put yourself in the customers shoes.
@@ -218,17 +219,13 @@ These are some questions to keep in mind when drafting your first or future rele
218
219
219
220
Once you're happy, hit `Publish release` 🎉🎉🎉.
220
221
221
-
This will kick off the [Publish docs on release](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/workflows/publish-docs-on-release.yml) workflow and within a few minutes you should see the latest version in PyPi, and all issues labeled as `pending-release` will be closed and notified.
222
-
223
-
### Run end to end tests
224
-
225
-
E2E tests should be ran before every merge to `main` or manually via [run-e2e-tests workflow](https://github.com/aws-powertools/powertools-lambda-typescript/actions/workflows/run-e2e-tests.yml) before making a release.
226
-
227
-
To run locally, you need [AWS CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_prerequisites) and an [account bootstrapped](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html) (`cdk bootstrap`). With a default AWS CLI profile configured, or `AWS_PROFILE` environment variable set, run `npm run test:e2e -ws`.
222
+
This will kick off the [Publish docs on release](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/workflows/publish-docs-on-release.yml) workflow that will will notify all the issues labeled as `status/pending-release` of the new release.
228
223
229
224
### Releasing a documentation hotfix
230
225
231
-
You can rebuild the latest documentation without a full release via this [GitHub Actions Workflow](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/workflows/publish-docs-on-release.yml). Choose `Run workflow`, keep `main` as the branch, and input the latest Powertools for AWS Lambda (TypeScript) version available i.e. `v1.4.1`.
226
+
You can rebuild the latest documentation without a full release via this [GitHub Actions Workflow](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/.github/workflows/rebuild-latest-docs.yml).
227
+
228
+
Choose `Run workflow`, keep `main` as the branch, and input the latest Powertools for AWS Lambda (TypeScript) version available i.e. `v1.4.1`.
232
229
233
230
This workflow will update both user guide and API documentation.
234
231
@@ -296,10 +293,6 @@ Try offering a 1:1 call in the attempt to get to a mutual understanding and clar
296
293
297
294
In the rare cases where both parties don't have the bandwidth or expertise to continue, it's best to use the `status/on-hold` label. By then, see if it's possible to break the PR or issue in smaller chunks, and eventually close if there is no progress.
Copy file name to clipboardExpand all lines: docs/roadmap.md
+20-11
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,39 @@
1
1
## Overview
2
2
3
-
This is our public roadmap that outlines the high level direction we are working towards, namely [Themes](#themes). We update this document when our priorities change: security and stability is our top priority.
3
+
This is our public roadmap that outlines the high level direction we are working towards, namely [Themes](#themes). We update this document when our priorities change, however security and stability is always our top priority.
4
4
5
-
[See our latest list of activities »](https://github.com/orgs/awslabs/projects/76/views/2){target="_blank"}
5
+
[See our latest list of activities »](https://github.com/orgs/aws-powertools/projects/7){target="_blank"}
6
6
7
7
## Themes
8
8
9
9
!!! info "Operational Excellence is priority number 1."
10
10
11
11
Themes are key activities maintainers are focusing on, besides bug reports. These are updated periodically and you can get an idea of the overall progress in the [Milestones section](https://github.com/aws-powertools/powertools-lambda-typescript/milestones){target="_blank"}.
12
12
13
-
### New utilities
13
+
### Feature Parity
14
14
15
-
After going GA, we want to start working on new utilities, specifically but not limited to the most commonly asked: **(1)**[Idempotency](https://github.com/aws-powertools/powertools-lambda-typescript/issues/447) and **(2)**[Parameters](https://github.com/aws-powertools/powertools-lambda-typescript/issues/846).
15
+
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.
16
16
17
-
### Lambda Layers
17
+
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.
18
18
19
-
We want to publish and maintain public Lambda Layers.
19
+
For the second half of 2023, we are considering implementing one or more of the following utilities (in no particular order):
Work on this area is mostly complete and layers are already available in all commercial regions, however we still have some [work to do around automation](https://github.com/aws-powertools/powertools-lambda-typescript/issues/1124).
25
+
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"}.
22
26
23
-
### ES Modules support
27
+
### Version 2 release
24
28
25
-
Another one of the most requested features is [ES Modules support](https://github.com/aws-powertools/powertools-lambda-typescript/issues/521). This topic requires some in-depth investigation to understand how to move forward and how to deal with some of our upstream dependencies.
29
+
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.
26
30
27
-
When the time comes, we might open a RFC to discuss options.
31
+
The following are some of the changes we are considering:
32
+
-**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.
33
+
-**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.
34
+
-**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.
35
+
36
+
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.
28
37
29
38
### Improve operational excellence
30
39
@@ -42,7 +51,7 @@ graph LR
42
51
<i>Visual representation</i>
43
52
</center>
44
53
45
-
Within our [public board](https://github.com/orgs/awslabs/projects/76/views/3){target="_blank"}, you'll see the following values in the `Status` column:
54
+
Within our [public board](https://github.com/orgs/aws-powertools/projects/7){target="_blank"}, you'll see the following values in the `Status` column:
46
55
47
56
***Ideas**. Incoming and existing feature requests that are not being actively considered yet. These will be reviewed when bandwidth permits and based on demand.
48
57
***Backlog**. Accepted feature requests or enhancements that we want to work on.
0 commit comments