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

Inputs folder does not allow non-json file but cfn bundles it #1046

Open
hanseltime opened this issue Dec 5, 2023 · 1 comment
Open

Inputs folder does not allow non-json file but cfn bundles it #1046

hanseltime opened this issue Dec 5, 2023 · 1 comment

Comments

@hanseltime
Copy link

Description

I ran into this recently while setting up an example typescript cloudformation resource repository with a lot more tooling and documentation.

What I had wanted to do was add a README.md to that folder so that I could have better documentation for people looking through the directory.

As part of maturing this tool, I think it would be worth either providing a ".cfn-ignore" file or a hook for file copy transforms (the latter would be more valuable for things like adding comments to json but that may be a separate feature request).

I could implement the feature, but would like to submit this to see if there are strong opinions about the ignore file, etc.

Thanks in advance!

@hanseltime
Copy link
Author

After taking a look at the code, I realize that somehting like a cfn-ignore file would require every plugin to honor the same contract (since those plugins are doing their own bundling from sources to ResourceProvider.zip). Because that migration path feels like it would require a ton of configuration, I have instead proposed that we just filter any non-json files from inputs/ out of the bundled resource package in the linked PR.

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

No branches or pull requests

1 participant