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

Fix the usability of templateFolder and outputFolder #87

Merged
merged 1 commit into from Feb 25, 2022

Conversation

yorinasub17
Copy link
Contributor

Description

This updates the templateFolder and outputFolder helpers to return absolute paths instead of the raw, relative paths. Using relative paths breaks the intended usage of these functions, which is to create relative paths in templates. Specifically, these functions return garbage values when using relative path inputs to --template-url and --output-folder, as these get repeated in the boilerplate blueprints, leading to broken relative pathing.

Using absolute paths ensure that the relative paths constructed in the boilerplate templates always point to the intended locations.

TODOs

Please ensure all of these TODOs are completed before asking for a review.

  • Ensure the branch is named correctly with the issue number. e.g: feature/new-vpc-endpoints-955 or bug/missing-count-param-434.
  • Update the docs.
  • Keep the changes backward compatible where possible.
  • Run the pre-commit checks successfully.
  • Run the relevant tests successfully.

Note on backward compatibility

I intend to release this as backward incompatible release given that the output of templateFolder and outputFolder changes, which will break anything that renders it in, say, docs, but for most use cases of those helpers, this should be functionally equivalent. E.g., I don't expect these changes to break our Reference Architecture.

All this is to say that there will be an explanation, but no migration guide will be provided given the functional equivalence.

Copy link
Contributor

@zackproser zackproser left a comment

Choose a reason for hiding this comment

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

LGTM

@yorinasub17
Copy link
Contributor Author

Thanks for review! Merging this now.

@yorinasub17 yorinasub17 merged commit f03a8a9 into master Feb 25, 2022
@yorinasub17 yorinasub17 deleted the bug/fix-usability-of-templatefolder branch February 25, 2022 17:14
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.

None yet

2 participants