-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add --serverless-rules to sam validate --lint #7950
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.
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
base: develop
Are you sure you want to change the base?
Conversation
26e31e0
to
b524fb7
Compare
Two comments.
sam validate --lint --extra-lint-rules "cfn_lint_serverless.rules" (I don't know if that's the best name for the parameter, but that's the idea) We would then keep this part of the code linter_config["append_rules"] = extra_cfn_lint_config but we won't do any special checks specifically for |
- Mark existing --serverless-rules option as deprecated - Add more flexible --extra-lint-rules option - Implement support for comma-separated multiple rule modules - Design to work regardless of installation environment - Update documentation and schema accordingly
bd7404d
to
f75e51d
Compare
Issue: Enhance --extra-lint-rules Feature in SAM CLI (Addressing Review Feedback)DescriptionThis PR enhances the Addressed Feedback
Test Code Improvements
Implementation Details
Related PR |
@valerena |
Which issue(s) does this change fix?
This PR adds a new feature and is not associated with a specific issue number.
Why is this change necessary?
The AWS SAM CLI's
validate --lint
command is useful for validating CloudFormation templates, but currently lacks the ability to apply rules specific to Serverless applications. Serverless applications have different characteristics compared to general CloudFormation templates, requiring additional validation rules tailored to their specific needs.How does it address the issue?
This PR adds a
--serverless-rules
option to thesam validate --lint
command, allowing users to leverage rules from the cfn-lint-serverless package. This enables users to perform additional validations specific to Serverless applications. When enabled, this option validates Serverless application best practices such as Lambda function memory size, timeout, log retention, API Gateway stage logging, and throttling settings.What side effects does this change have?
--serverless-rules
option is only activated when explicitly specified.Mandatory Checklist
PRs will only be reviewed after checklist is complete
make pr
passesmake update-reproducible-reqs
if dependencies were changedBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.