feat: add --serverless-rules to sam validate --lint #7950
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area/validate
shashax42
force-pushed
the
feature/serverless-rules-lint
branch
from
26e31e0 to
b524fb7
Compare
vicheey
reviewed
Mar 26, 2025
| @@ -57,20 +57,27 @@ class SamTemplate: | |||
| "Create a cfnlintrc config file to specify additional parameters. " | |||
| "For more information, see: https://github.com/aws-cloudformation/cfn-lint", | |||
| ) | |||
| @click.option( | |||
| "--serverless-rules", | |||
| is_flag=True, | |||
There was a problem hiding this comment.
Any particular region to enable this flag by default?
There was a problem hiding this comment.
@vicheey No, there's no particular region requirement. You can enable this flag by default in all regions.
vicheey
added
need-customer-response
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 --lintcommand 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-rulesoption to thesam validate --lintcommand, 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-rulesoption is only activated when explicitly specified.Mandatory Checklist
PRs will only be reviewed after checklist is complete
make prpassesmake update-reproducible-reqsif dependencies were changedBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.