-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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: CloudFormation docs in schema #2816
Merged
Merged
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
GavinZZ
reviewed
Jan 26, 2023
acristin
reviewed
Jan 26, 2023
GavinZZ
approved these changes
Jan 26, 2023
acristin
approved these changes
Jan 26, 2023
ssenchenko
approved these changes
Jan 26, 2023
aaythapa
reviewed
Jan 26, 2023
aaythapa
approved these changes
Jan 26, 2023
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.
Issue #, if available
Description of changes
Adds CloudFormation docs to schema:
Currently uses heuristics to guess the documentation page matching
definitions
in the CloudFormation JSON schema.It works reasonably well (e.g.
AWS::EC2::CapacityReservationFleet.TagSpecification
corresponds toaws-properties-ec2-capacityreservation-tagspecification.md
), but there are exceptions such asAWS::EC2::Instance.Ebs
which correspond toaws-properties-ec2-blockdev-template.md
. 🤔There are probably more robust ways of cross-referencing, without depending on a specific format as provided by GoFormation, and without heuristics (e.g. using the CloudFormation resource specification, which includes a
Documentation
URL which has the correct slug).The decompressed sizes are relatively large (7 to 11 MB), but all compress nicely (3 MB in total gzipped).
Description of how you validated changes
Checked diff and tested sample templates in VS Code.
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.