Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Having additional checks in case ./apis/v1alpha1 is missing. #222

Open
remyleone opened this issue Feb 3, 2022 · 3 comments
Open

Having additional checks in case ./apis/v1alpha1 is missing. #222

remyleone opened this issue Feb 3, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request wontfix This will not be worked on

Comments

@remyleone
Copy link

What happened?

When I was trying to debug code generation I didn't knew that ./apis/v1alpha1 should be kept. I've deleted it and it was not evident for me to go back to the template to copy and paste this boilerplate.

Maybe it could be a good idea to have additional checks in angryjet to detect if this folder/file is missing. It could even be generated from angryjet.
If it cannot, having a README.md in the api folder of the template could be helpful to understand the folder that should be kept and the one that will be generated.

How can we reproduce it?

@remyleone remyleone added the bug Something isn't working label Feb 3, 2022
@turkenh
Copy link
Member

turkenh commented Feb 7, 2022

At some point we also had some target like make terrajet.clean which removes all generated files to have a fresh start. We removed that after adding this cleanup as an initial step for make generate as it would not be required to be called explicitly.

Maybe we can add something similar just to better point out what is generated or not and have a way to start fresh :)

@turkenh turkenh added documentation Improvements or additions to documentation enhancement New feature or request and removed bug Something isn't working labels Feb 7, 2022
@remyleone
Copy link
Author

Yes, it would be very helpful to have a command that cleans and generate everything again from scratch. It would lower the mental load to think about what are the generated files and what are the files that are not. It was not easy for me to understand what files should remain and what files should be completed by hand.

@stale
Copy link

stale bot commented Aug 13, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Aug 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants