From d3672674b598266b5521d7af2a1e77822fc4a74e Mon Sep 17 00:00:00 2001 From: Nicola Racco Date: Wed, 31 Jul 2024 19:29:41 +0200 Subject: [PATCH 1/2] docs: remove headings from method doc (#30965) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### Issue # (if applicable) The documentation for [Stack#exportValue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Stack.html#exportwbrvalueexportedvalue-options) contains an “Example” section formatted as an H2 with two H3 sub-sections, whereas the method signature uses an H3. When generating documentation for CDK libraries inheriting from Stack, and jsii duplicates this “Example” section for each stack in the application in the API.md, this formatting issue causes a disruption in the heading hierarchy. This is particularly problematic on constructs.dev, where H3 headings are listed in the sidebar. Examples can be seen at: - https://constructs.dev/packages/@condensetech/cdk-constructs/v/0.1.2?lang=typescript - https://constructs.dev/packages/@cloudcomponents/cdk-temp-stack/v/2.4.0?lang=typescript - https://constructs.dev/packages/@gammarers/aws-lambda-function-invoke-error-notification-stack/v/1.0.49?lang=typescript ### Reason for this change By removing any heading from the method doc, there's no risk of altering the generated markdown hierarchy ### Description of changes I've removed the headings from the method documentation ### Description of how you validated changes N/A ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- packages/aws-cdk-lib/core/lib/stack.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/aws-cdk-lib/core/lib/stack.ts b/packages/aws-cdk-lib/core/lib/stack.ts index b946d73974973..ce3cb9c9b9fd8 100644 --- a/packages/aws-cdk-lib/core/lib/stack.ts +++ b/packages/aws-cdk-lib/core/lib/stack.ts @@ -1171,8 +1171,6 @@ export class Stack extends Construct implements ITaggable { * remove the reference from the consuming stack. After that, you can remove * the resource and the manual export. * - * ## Example - * * Here is how the process works. Let's say there are two stacks, * `producerStack` and `consumerStack`, and `producerStack` has a bucket * called `bucket`, which is referenced by `consumerStack` (perhaps because @@ -1183,7 +1181,7 @@ export class Stack extends Construct implements ITaggable { * * Instead, the process takes two deployments: * - * ### Deployment 1: break the relationship + * **Deployment 1: break the relationship**: * * - Make sure `consumerStack` no longer references `bucket.bucketName` (maybe the consumer * stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just @@ -1193,7 +1191,7 @@ export class Stack extends Construct implements ITaggable { * between the two stacks is being broken. * - Deploy (this will effectively only change the `consumerStack`, but it's safe to deploy both). * - * ### Deployment 2: remove the bucket resource + * **Deployment 2: remove the bucket resource**: * * - You are now free to remove the `bucket` resource from `producerStack`. * - Don't forget to remove the `exportValue()` call as well. From ad3a25d539dd98e16385413fcbb415230e3706ce Mon Sep 17 00:00:00 2001 From: Melle van der Linde <118454433+mellevanderlinde@users.noreply.github.com> Date: Wed, 31 Jul 2024 20:00:29 +0200 Subject: [PATCH 2/2] chore(apprunner-alpha): add runtimes PYTHON_311 and NODEJS_18 (#30149) ### Issue # (if applicable) Closes #30146. ### Reason for this change Runtimes Python 3.11 and NodeJS 18 were missing. ### Description of changes Runtimes Python 3.11 and NodeJS 18 were added. ### Description of how you validated changes No tests were added, as it seems not required for this type of change. ### Checklist - [*] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts b/packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts index d70d0730034c8..80040c76ad560 100644 --- a/packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts +++ b/packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts @@ -202,6 +202,11 @@ export class Runtime { */ public static readonly NODEJS_16 = Runtime.of('NODEJS_16') + /** + * NodeJS 18 + */ + public static readonly NODEJS_18 = Runtime.of('NODEJS_18') + /** * PHP 8.1 */ @@ -212,6 +217,11 @@ export class Runtime { */ public static readonly PYTHON_3 = Runtime.of('PYTHON_3') + /** + * Python 3.11 + */ + public static readonly PYTHON_311 = Runtime.of('PYTHON_311') + /** * Ruby 3.1 */