(appconfig): Linter errors must be audited #27894
Labels
@aws-cdk/aws-appconfig
Related to AWS AppConfig
bug
This issue is a bug.
effort/small
Small work item – less than a day of effort
p1
Comments
kaizencc
added
bug
kaizencc
added
p1
effort/small
mergify bot
pushed a commit
that referenced
this issue
Nov 8, 2023
Most issues center around doc strings. I know nothing about appconfig, but I feel like there's massive value added to this module by providing even the cloudformation docs within cdk, so that they are accessible within the IDE. Some other linter rules I've added as exceptions, because I don't have the capacity to audit them, but they should be audited. Issue to track that work: #27894. Labeled as a fix because technically, some public facing code has changed and also I want to make sure this ends up on the changelog. BREAKING CHANGE: `Environment.fromEnvironmentAttributes` function signature changed; property called `attr` is now `attrs`. This should affect only Python users. - **appconfig**: `Extension.fromExtensionAttributes` function signature changed; property called `attr` is now `attrs`. This should affect only Python users. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
mikewrighton
pushed a commit
that referenced
this issue
Nov 13, 2023
Most issues center around doc strings. I know nothing about appconfig, but I feel like there's massive value added to this module by providing even the cloudformation docs within cdk, so that they are accessible within the IDE. Some other linter rules I've added as exceptions, because I don't have the capacity to audit them, but they should be audited. Issue to track that work: #27894. Labeled as a fix because technically, some public facing code has changed and also I want to make sure this ends up on the changelog. BREAKING CHANGE: `Environment.fromEnvironmentAttributes` function signature changed; property called `attr` is now `attrs`. This should affect only Python users. - **appconfig**: `Extension.fromExtensionAttributes` function signature changed; property called `attr` is now `attrs`. This should affect only Python users. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
mergify bot
pushed a commit
that referenced
this issue
Jan 18, 2024
…28671) Auditing awslint errors. Reasons for keeping current list of exemptions: * "no-unused-type:@aws-cdk/aws-appconfig-alpha.PredefinedDeploymentStrategyId" - will be fixed in a separate PR. * "props-physical-name:@aws-cdk/aws-appconfig-alpha.ApplicationProps" "props-physical-name:@aws-cdk/aws-appconfig-alpha.DeploymentStrategyProps" "props-physical-name:@aws-cdk/aws-appconfig-alpha.EnvironmentProps" "props-physical-name:@aws-cdk/aws-appconfig-alpha.ExtensionProps" - will be fixed in a separate PR. * "events-method-signature" - exempting because appconfig handles their events without cloudwatch events * "events-generic" - exempting because appconfig handles their events without cloudwatch events Closes #27894 alongside #28742 and #28743 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
AppConfig L2 in alpha stage was released without the linter checker turned on, so none of these linter exceptions have been audited. These rules likely should be fixed rather than exempted, which could result in breaking changes. Marking this as a
p1because this issue should block any potential graduation of the AppConfig module.As seen in the awslint.json file:
{ "no-unused-type:@aws-cdk/aws-appconfig-alpha.PredefinedDeploymentStrategyId", "ref-via-interface:@aws-cdk/aws-appconfig-alpha.Application.addAgentToEcs.taskDef", "props-physical-name:@aws-cdk/aws-appconfig-alpha.ApplicationProps", "props-physical-name:@aws-cdk/aws-appconfig-alpha.DeploymentStrategyProps", "props-physical-name:@aws-cdk/aws-appconfig-alpha.EnvironmentProps", "props-physical-name:@aws-cdk/aws-appconfig-alpha.ExtensionProps", "events-in-interface", "events-method-signature", "events-generic" }Expected Behavior
No linter errors
Current Behavior
Linter rules are being exempted
Reproduction Steps
n/a
Possible Solution
No response
Additional Information/Context
No response
CDK CLI Version
2.100.0
Framework Version
No response
Node.js Version
20
OS
Mac
Language
TypeScript
Language Version
No response
Other information
No response
The text was updated successfully, but these errors were encountered: