Skip to content

Commit b3de8e0

Browse files
committed
docs(roadmap): move v3 up top due to pydantic v1 EOL
Signed-off-by: heitorlessa <[email protected]>
1 parent 8946123 commit b3de8e0

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/roadmap.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,26 @@ We want to investigate security and scaling requirements for these special regio
4040
* [x] Update CDK Layer construct to include regions
4141
* [ ] Distribution sign-off
4242

43+
### V3
44+
45+
We are in the process of planning the roadmap for v3. As always, [our approach](./versioning.md){target="_blank"} includes providing sufficient advance notice, a comprehensive upgrade guide, and minimizing breaking changes to facilitate a smooth transition (e.g., it took ~7 months from v2 to surpass v1 downloads).
46+
47+
For example, these are on our mind but not settled yet until we have a public tracker to discuss what these means in detail.
48+
49+
* **Parser**: Drop Pydantic v1
50+
* **Parser**: Deserialize Amazon DynamoDB data types automatically (like Event Source Data Classes)
51+
* **Parameters**: Increase default `max_age` for `get_secret`
52+
* **Event Source Data Classes**: Return sane defaults for any property that has `Optional[<type>]` returns
53+
* **Upgrade tool**: Consider building a CST (Concrete Syntax Tree) tool to ease certain upgrade actions like `pyupgrade` and `django-upgrade`
54+
* **Batch**: Stop at first error for Amazon DynamoDB Streams and Amazon Kinesis Data Streams (e.g., `stop_on_failure=True`)
55+
56+
**Major updates**
57+
58+
* [ ] Create an issue to track breaking changes we consider making
59+
* [ ] Create a v3 branch to allow early experimentation
60+
* [ ] Create workflows to allow pre-releases
61+
* [ ] Create a mechanism to keep ideas for breaking change somewhere regardless of v3
62+
4363
### Revamp Event Handler
4464

4565
Event Handler provides lightweight routing for both [**REST**: Amazon API Gateway, Amazon Elastic Load Balancer and AWS Lambda Function URL](./core/event_handler/api_gateway.md), and [**GraphQL**: AWS AppSync](./core/event_handler/appsync.md).
@@ -98,26 +118,6 @@ We want to make this easier by extending certain utilities to accept a `metrics`
98118
* [ ] RFC to outline metrics for Event Handler (_e.g., validation errors_ )
99119
* [ ] RFC to outline metrics for Idempotency (_e.g., cache hit_)
100120

101-
### V3
102-
103-
We are in the process of planning the roadmap for v3. As always, [our approach](./versioning.md){target="_blank"} includes providing sufficient advance notice, a comprehensive upgrade guide, and minimizing breaking changes to facilitate a smooth transition (e.g., it took ~7 months from v2 to surpass v1 downloads).
104-
105-
For example, these are on our mind but not settled yet until we have a public tracker to discuss what these means in detail.
106-
107-
* **Parser**: Drop Pydantic v1
108-
* **Parser**: Deserialize Amazon DynamoDB data types automatically (like Event Source Data Classes)
109-
* **Parameters**: Increase default `max_age` for `get_secret`
110-
* **Event Source Data Classes**: Return sane defaults for any property that has `Optional[<type>]` returns
111-
* **Upgrade tool**: Consider building a CST (Concrete Syntax Tree) tool to ease certain upgrade actions like `pyupgrade` and `django-upgrade`
112-
* **Batch**: Stop at first error for Amazon DynamoDB Streams and Amazon Kinesis Data Streams (e.g., `stop_on_failure=True`)
113-
114-
**Major updates**
115-
116-
* [ ] Create an issue to track breaking changes we consider making
117-
* [ ] Create a v3 branch to allow early experimentation
118-
* [ ] Create workflows to allow pre-releases
119-
* [ ] Create a mechanism to keep ideas for breaking change somewhere regardless of v3
120-
121121
## Roadmap status definition
122122

123123
<center>

0 commit comments

Comments
 (0)