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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Automate running of the API generator #667

Open
Xtansia opened this issue Jun 4, 2024 · 0 comments
Open

[FEATURE] Automate running of the API generator #667

Xtansia opened this issue Jun 4, 2024 · 0 comments
Labels
code-gen enhancement New feature or request good first issue Good for newcomers

Comments

@Xtansia
Copy link
Collaborator

Xtansia commented Jun 4, 2024

Is your feature request related to a problem?

Currently the API generator requires manual running and may fall out of sync with the OpenAPI specification. Changes to the generator or generated code may not be properly caught in PRs if the generator is not run to check for discrepancies.

What solution would you like?

GitHub workflow(s) that:

  • On PRs:
    1. Builds and runs the API Generator against the currently checked in spec
    2. Fails if any changes are detected
  • On a Schedule:
    1. Builds and runs the API Generator against the LATEST spec (ie. passing --download to generator)
    2. Raises a PR if any changes are detected
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code-gen enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Xtansia