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

Automatically update OpenAPI specs on PR #289

Open
silvanheller opened this issue Apr 8, 2022 · 3 comments
Open

Automatically update OpenAPI specs on PR #289

silvanheller opened this issue Apr 8, 2022 · 3 comments
Labels
enhancement Good First Issue Good Issue for first-time contributors help wanted

Comments

@silvanheller
Copy link
Member

Currently, code review for PRs has to manually check whether there is a need for the OpenAPI specs to be updated, and then that has to be done manually.

One good way to avoid this Problem would be to have a Github Action that automatically re-generates the OpenAPI specs on each PR and then pushes the changes to the PR branch. This can be done using https://github.com/ad-m/github-push-action.

@sauterl
Copy link
Collaborator

sauterl commented Apr 8, 2022

This is a very good idea!

Currently, the way to generate the OAS, one starts locally a Cineast instance and downloads the OAS from there.

There is (or was at one point) a CLI command to generate the OAS, which might be handier in this particular case.

@silvanheller
Copy link
Member Author

I think you just run ./gradlew generateOpenApiSpecs (at least this is what is documented in the README)

@sauterl
Copy link
Collaborator

sauterl commented Apr 8, 2022

@silvanheller Indeed, ots nothong more than ./graldew generateOpenApi.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Good First Issue Good Issue for first-time contributors help wanted
Projects
None yet
Development

No branches or pull requests

2 participants