Skip to content

Conversation

@Vandita2020
Copy link
Contributor

@Vandita2020 Vandita2020 commented Jul 28, 2025

Issue #, if available

#3682 , #3779

Description of changes

SAM's CFN schema used to get updated automatically with the changes in the CloudFormation schema. CloudFormation Schema update came from awslabs/goformation repository. Refer to this diagram to understand more in detail on how the schema changes work.

The goformation repository hasn't been updated since nine months and as of Oct 17, 2024 the repository has been archived. This means that for more than 9 months the CloudFormation Schema has not getting updated for SAM.

Since the goformation repository is now been archived, I have forked the GoFormation repo, run the go generate command that generated the updated CFN schema, and then executed the commands from the MakeFile to properly update the current cloudformation.schema.json, cloudformation-docs.json and schema.json files.

mkdir -p .tmp
cp /path/to/your/updated/cloudformation.schema.json .tmp/cloudformation.schema.json
bin/parse_cdk_cfn_docs.py < .tmp/cfn-docs.json > schema_source/cloudformation-docs.json
python bin/add_docs_cfn_schema.py --schema .tmp/cloudformation.schema.json --docs schema_source/cloudformation-docs.json > schema_source/cloudformation.schema.json
python -m samtranslator.internal.schema_source.schema --sam-schema schema_source/sam.schema.json --cfn-schema schema_source/cloudformation.schema.json --unified-schema samtranslator/schema/schema.json

Description of how you validated changes

Checklist

Examples?

Please reach out in the comments if you want to add an example. Examples will be
added to sam init through aws/aws-sam-cli-app-templates.

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

@Vandita2020 Vandita2020 marked this pull request as ready for review July 28, 2025 23:13
@Vandita2020 Vandita2020 requested a review from a team as a code owner July 28, 2025 23:13
Copy link
Contributor

@valerena valerena left a comment

Choose a reason for hiding this comment

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

I didn't go through every single change here, but I did get the changes locally (using gh pr checkout 3797) and everything I checked looks okay. The deletion are some renaming, and some places where the diff is confused because a new things appeared (so instead of just showing something "new", it shows something "changed" + something "new"), and the deletion of some "required" fields (that are no longer required). So it looks good to me. Thanks!

@Vandita2020 Vandita2020 merged commit 880c41e into aws:develop Jul 29, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants