Skip to content
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.

Sign up for GitHub

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

Jump to bottom

(ec2): Adding a vpc endpoint in the wrong way #22576

Closed
watany-dev opened this issue Oct 20, 2022 · 2 comments · Fixed by #22613
Closed

(ec2): Adding a vpc endpoint in the wrong way #22576

watany-dev opened this issue Oct 20, 2022 · 2 comments · Fixed by #22613
Labels
@aws-cdk/aws-ec2 Related to Amazon Elastic Compute Cloud bug This issue is a bug. effort/small Small work item – less than a day of effort p2

Comments

@watany-dev
Copy link
Contributor

Describe the bug

I am afraid that the correction method implemented in #22481 was a mistake.

In this PR, if you just add a property, the following error will be output, so comments are added to each line as a suppressive measure

error: [awslint:docs-public-apis:@aws-cdk/aws-ec2.InterfaceVpcEndpointAwsService.APPLICATION_MIGRATION_SERVICE] Public API element must have a docstring

However, in this similar PR the properties appear to be set in aws-ec2/package.json.
#22558

Should I remove the comment and add the content to package.json?

Expected Behavior

None

Current Behavior

judging by looking at the code

Reproduction Steps

I don't think it affects operation.

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

any

Framework Version

No response

Node.js Version

any

OS

any

Language

Typescript

Language Version

No response

Other information

No response
@watany-dev watany-dev added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Oct 20, 2022
@github-actions github-actions bot added the @aws-cdk/aws-ec2 Related to Amazon Elastic Compute Cloud label Oct 20, 2022
@corymhall
Copy link
Contributor

@watany-dev yeah it might be best to just add the exceptions to package.json.

@corymhall corymhall added p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Oct 20, 2022
@corymhall corymhall removed their assignment Oct 20, 2022
@watany-dev watany-dev mentioned this issue Oct 23, 2022
Merged
4 tasks
@mergify mergify bot closed this as completed in #22613 Oct 25, 2022
mergify bot pushed a commit that referenced this issue Oct 25, 2022
@watany-dev
refactor(ec2): fix endpoint comment style (#22613)
7a36fc8 
- before: 
    - Write service name in comments to suppress @aws-lint error messages
- after: 
    - Add the exceptions to package.json

Fixes: #22576

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-ec2 Related to Amazon Elastic Compute Cloud bug This issue is a bug. effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor(ec2): fix endpoint comment style watany-dev/aws-cdk
2 participants
@corymhall @watany-dev