feat(ec2): add `versionDescription` property for `LaunchTemplate` by yuppe-kyupeen · Pull Request #30837 · aws/aws-cdk

yuppe-kyupeen · 2024-07-12T06:46:16Z

Issue # (if applicable)

Reason for this change

The change introduces the versionDescription property to the LaunchTemplate

Description of changes

Add the versionDescription property for LaunchTemplateProps, which was missing in the L2 construct.
Add validation for character limit

Description of how you validated changes

I Added a unit test for launch template and added the versionDescription property in the integration tests.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

go-to-k · 2024-07-12T10:29:10Z

packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts

+  /**
+   * A description for the first version of the launch template.
+   * The version descrioption must be maximum 255 characters long, including hyphens (-),
+   * underscores (_), spaces, and tabs.
+   *
+   * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription
+   */
+  readonly versionDescription?: string;


The CodeBuild CI seems to be failing. Optional properties must have @default documentation. Could you add the label and description to the JSDoc?

aws-cdk-lib: error: [awslint:props-default-doc:aws-cdk-lib.aws_ec2.LaunchTemplateProps.versionDescription] Optional property must have @default documentation aws-cdk-lib: Error: /codebuild/output/src1195990305/src/github.com/aws/aws-cdk/tools/@aws-cdk/cdk-build-tools/bin/cdk-awslint exited with error code 1 aws-cdk-lib: Build failed.!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

go-to-k · 2024-07-12T10:39:51Z

packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts

+   * The version descrioption must be maximum 255 characters long, including hyphens (-),
+   * underscores (_), spaces, and tabs.


including hyphens (-), * underscores (_), spaces, and tabs.

Is there documentation available to confirm this? (I could not find that in the CFn documentation.)

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-versiondescription

go-to-k · 2024-07-12T10:53:01Z

packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts

+   * A description for the first version of the launch template.
+   * The version descrioption must be maximum 255 characters long, including hyphens (-),


A line break would make it clearer.

Suggested change

* A description for the first version of the launch template.

* The version descrioption must be maximum 255 characters long, including hyphens (-),

* A description for the first version of the launch template.

*

* The version descrioption must be maximum 255 characters long, including hyphens (-),

yuppe-kyupeen · 2024-07-13T03:41:35Z

@go-to-k
Thank you for the review!
I have addressed the points you mentioned.I apologize for any oversights.
Please review the changes.Thank you!

packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts

Co-authored-by: Kenta Goto (k.goto) <24818752+go-to-k@users.noreply.github.com>

go-to-k

Thanks for the changes. Approved.

yuppe-kyupeen · 2024-07-13T15:46:33Z

@go-to-k
thank you!

gracelu0

Hi @yuppe-kyupeen , thanks for your contribution. Just one small typo to fix, otherwise LGTM!

packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts

Co-authored-by: Grace Luo <54298030+gracelu0@users.noreply.github.com>

yuppe-kyupeen · 2024-07-24T00:29:44Z

Hi @gracelu0, thanks for your review and suggestion! 👍

mergify · 2024-07-24T00:32:03Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2024-07-24T01:01:51Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 70c9be5
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-07-24T01:02:10Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2024-07-24T01:02:24Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

…s#30837) ### Issue # (if applicable) ### Reason for this change The change introduces the `versionDescription` property to the `LaunchTemplate` ### Description of changes - Add the `versionDescription` property for `LaunchTemplateProps`, which was missing in the L2 construct. - Add validation for character limit ### Description of how you validated changes I Added a unit test for launch template and added the `versionDescription` property in the integration tests. ### 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*

aws-cdk-automation · 2024-07-25T17:42:04Z

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

feat(ec2): add versionDescription property for launch template

c3d69db

aws-cdk-automation requested a review from a team July 12, 2024 06:46

github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Jul 12, 2024

yuppe-kyupeen changed the title ~~feat(ec2): add versionDescription property for launch template~~ feat(ec2): add versionDescription property for LaunchTemplate Jul 12, 2024

go-to-k suggested changes Jul 12, 2024

View reviewed changes

go-to-k reviewed Jul 12, 2024

View reviewed changes

yuppe-kyupeen and others added 2 commits July 13, 2024 12:19

docs: Remove unnecessary comment and improve formatting

7163385

Merge branch 'main' into add-version-description-for-ec2

849e005

go-to-k suggested changes Jul 13, 2024

View reviewed changes

packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts Outdated Show resolved Hide resolved

Update packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts

0bec9e2

Co-authored-by: Kenta Goto (k.goto) <24818752+go-to-k@users.noreply.github.com>

go-to-k approved these changes Jul 13, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 13, 2024

github-actions bot mentioned this pull request Jul 15, 2024

Weekly PR metrics report #30858

Closed

Merge branch 'main' into add-version-description-for-ec2

115a68c

gracelu0 reviewed Jul 23, 2024

View reviewed changes

packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts Outdated Show resolved Hide resolved

yuppe-kyupeen and others added 2 commits July 24, 2024 08:50

Update packages/aws-cdk-lib/aws-ec2/lib/launch-template.ts

4a1505b

Co-authored-by: Grace Luo <54298030+gracelu0@users.noreply.github.com>

Merge branch 'main' into add-version-description-for-ec2

a2798a5

gracelu0 approved these changes Jul 24, 2024

View reviewed changes

Merge branch 'main' into add-version-description-for-ec2

70c9be5

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 24, 2024

mergify bot merged commit 597228c into aws:main Jul 24, 2024

yuppe-kyupeen deleted the add-version-description-for-ec2 branch July 24, 2024 01:02

aws locked as resolved and limited conversation to collaborators Jul 25, 2024

		* The version descrioption must be maximum 255 characters long, including hyphens (-),
		* underscores (_), spaces, and tabs.

		* A description for the first version of the launch template.
		* The version descrioption must be maximum 255 characters long, including hyphens (-),

Conversation

yuppe-kyupeen commented Jul 12, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

go-to-k Jul 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

go-to-k Jul 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

go-to-k Jul 12, 2024

Choose a reason for hiding this comment

Uh oh!

yuppe-kyupeen commented Jul 13, 2024

Uh oh!

Uh oh!

go-to-k left a comment

Choose a reason for hiding this comment

Uh oh!

yuppe-kyupeen commented Jul 13, 2024

Uh oh!

gracelu0 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yuppe-kyupeen commented Jul 24, 2024

Uh oh!

mergify bot commented Jul 24, 2024

Uh oh!

aws-cdk-automation commented Jul 24, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Jul 24, 2024

Uh oh!

github-actions bot commented Jul 24, 2024

Uh oh!

aws-cdk-automation commented Jul 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

go-to-k Jul 12, 2024 •

edited

Loading

go-to-k Jul 12, 2024 •

edited

Loading