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.

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

feat: Generate sam validate and sam package schema #5559

Merged
merged 3 commits into from
Jul 20, 2023

Conversation

Leo10Gama
Copy link
Member

With this change, the schema for sam validate and sam package will be added to the JSON schema. It will serve to validate the parameters in samconfig for the validate and package commands.

Mandatory Checklist

PRs will only be reviewed after checklist is complete

  • Add input/output type hints to new functions/methods
  • Write design document if needed (Do I need to write a design document?)
  • Write/update unit tests
  • Write/update integration tests
  • Write/update functional tests if needed
  • make pr passes
  • make update-reproducible-reqs if dependencies were changed
  • Write documentation

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

@Leo10Gama Leo10Gama requested a review from a team as a code owner July 18, 2023 22:51
@github-actions github-actions bot added pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. labels Jul 18, 2023
"resolve_s3": {
"title": "resolve_s3",
"type": "boolean",
"description": "Automatically resolve AWS S3 bucket for non-guided deployments. Enabling this option will also create a managed default AWS S3 bucket for you. If one does not provide a --s3-bucket value, the managed bucket will be used. Do not use --guided with this option."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not use --guided with this option.

I'm guessing this comes from the deploy command (or rather the option was written with the deploy command in mind and we are reusing it here)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, that seems to be the case. It uses a decorator method to produce the resolve_s3 click option, and the help text seems specifically catered to deploy. We could change that text if need be, to be more specific about "If running with deploy, do not use --guided", but I don't think it's completely necessary.

@lucashuy lucashuy merged commit f955a2b into aws:feat/json-schema Jul 20, 2023
73 checks passed
@Leo10Gama Leo10Gama deleted the validate-package-schema branch July 20, 2023 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants