"DO NOT EDIT" comments at the top of generated files.

cyclosproject / ng-openapi-gen

An OpenAPI 3.0 codegen for Angular

MIT License

397 stars 132 forks source link

"DO NOT EDIT" comments at the top of generated files. #314

Closed josephbuchma closed 1 month ago

josephbuchma commented 9 months ago

Just another reminder that you should edit openapi spec and re-generate code instead of editing these files directly.

luisfpg commented 1 month ago

I did some changes (duplicated comments were generated in objects) and merged. Anyway, generated files SHOULD be in .gitignore, and never committed to SCM.

josephbuchma commented 1 month ago

Thank you @luisfpg ! We do commit generated code, and it works well so far. Can you please suggest some resources on setting up a project where OpenAPI spec lives in a separate repository and generated code is not committed?

luisfpg commented 1 month ago

I've added a paragraph in https://github.com/cyclosproject/ng-openapi-gen?tab=readme-ov-file#setting-up-a-node-script