aws-cloudformation / cloudformation-cli

The CloudFormation Provider Development Toolkit allows you to author your own resource providers and modules that can be used by CloudFormation.
Apache License 2.0
318 stars 161 forks source link

fix(submit): only adding .json files from the inputs #1048

Open hanseltime opened 9 months ago

hanseltime commented 9 months ago

Issue #, if available: Relates to issue 1046

Description of changes:

While running cloudformation validation, if you add a README.md or anything into your inputs/ folder, you will only find out during submission that you failed to upload your resource type because the non-open source cloudformation code tries to parse every file into .json in that folder.

As a result, this PR proposes the simplest fix for cloudformation-cli users, which is only uploading .json files from the input folder. That way, developers can create supplemental information for their extensions and how they are expected to be tested.

PS: if this proposal is approved, I would like to also submit a follow-up PR to use a comment tolerating JSON library to process these json files into raw JSON so that maintainers can leave comments about why they have chosen certain payload configurations in the .json file itself.

Please feel free to push back on anything and let me know if there is a greater scope I'm missing!

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