meraki / dashboard-api-go

Dashboard API for Golang
MIT License
19 stars 7 forks source link

Make Build One Step #14

Closed ryan-berger closed 1 year ago

ryan-berger commented 1 year ago

Is your feature request related to a problem? Please describe. Currently while editing the dashboard templates or regenerating the library with newer specs, it can take a lot of setup and teardown.

Describe the solution you'd like It would be a good idea to create a Makefile that will take care of the building and code generation for us. Having to run through the commands and clean things up inside the client/ directory is pretty annoying for small changes.

Describe alternatives you've considered We could theoretically make the template a separate repo and vendor in the OpenAPI spec, but I think for now it would be best to have a Makefile that runs through all the commands inside of the README in the client/ directory.

iamdexterpark commented 1 year ago

That's a great suggestion. Using a Makefile to automate the build process will undoubtedly help save time.

An alternative worth considering is to leverage a tool like act to run GitHub Actions files locally.

By separating the existing "generate.yml" into "check-version.yml," "generate.yml," and "release.yml," we could preserve the triggered workflows and just run our targeted build process locally.

I have had success using this tool with other repositories, and it is potentially a fit here as well.

iamdexterpark commented 1 year ago

Added a Makefile and updated docs with detailed instructions.