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: Allow configuration of output YAML file extensions #297

Merged
merged 2 commits into from
Jan 28, 2022

Conversation

heckler1
Copy link
Contributor

Fixes #296

I've retained the current behavior as the default, and added a prop to App to allow configuration of the file extensions applied to the outputted YAML.

Please just let me know if you'd like any more information or if I need to make any changes!

Signed-off-by: Stephen Heckler <sheckler@cloudflare.com>
@heckler1 heckler1 force-pushed the sheckler/configure-file-extension branch from a0fd120 to 834716f Compare January 27, 2022 23:55
Copy link
Contributor

@Chriscbr Chriscbr left a comment

Choose a reason for hiding this comment

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

The API looks good to me!

@heckler1 this isn't required, but if you have a chance it would be helpful to document how to use these options on our explanatory docs - I think here could be a good spot for it: https://github.com/cdk8s-team/cdk8s/blob/master/docs/cli/synth.md 😄

@mergify mergify bot merged commit 14742f2 into cdk8s-team:2.x Jan 28, 2022
@heckler1 heckler1 deleted the sheckler/configure-file-extension branch January 28, 2022 21:55
@heckler1
Copy link
Contributor Author

Hey @Chriscbr, happy to add to the docs for sure. I'm a bit unsure where to put this though, I expected that the generated API docs would be synced from this repo into the doc/reference/cdk8s/ folder of the repo you linked, but that doesn't seem to be the case, as those are a few months old now.

I'm not sure that the changes to AppProps really belong in the CLI synth docs, but I can definitely still do a little writeup about Apps and their Props in that file or another one if you'd like.

@Chriscbr
Copy link
Contributor

Ahhh, yeah that's interesting. I did some looking and it looks like the API docs do get updated when we build the website, just not in the repository itself. I'll make a fix to prevent others getting confused by the same thing in the future. 😉

And sure - if you see a better place to put it or want to create a new file about output options, that's fine as well.

Chriscbr pushed a commit that referenced this pull request Jan 28, 2022
Fixes #296 

I've retained the current behavior as the default, and added a prop to `App` to allow configuration of the file extensions applied to the outputted YAML.

Please just let me know if you'd like any more information or if I need to make any changes!
Signed-off-by: Christopher Rybicki <rybickic@amazon.com>
Chriscbr added a commit that referenced this pull request Jan 28, 2022
Fixes #296 

I've retained the current behavior as the default, and added a prop to `App` to allow configuration of the file extensions applied to the outputted YAML.

Please just let me know if you'd like any more information or if I need to make any changes!
Signed-off-by: Christopher Rybicki <rybickic@amazon.com>

Co-authored-by: S Heckler <55748928+heckler1@users.noreply.github.com>
mergify bot pushed a commit to cdk8s-team/cdk8s that referenced this pull request Jan 31, 2022
…832)

As mentioned by @Chriscbr on cdk8s-team/cdk8s-core#297

I thought about this over the weekend and I think this is in the spirit of what you were asking, let me know, I'm happy to make any changes.
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.

Make output files extension configurable
2 participants