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

Setup GitHub Workflow for OpenAPI/Swagger Client Generation #294

Open
5 tasks
jimmypalelil opened this issue Jan 29, 2025 · 0 comments
Open
5 tasks

Setup GitHub Workflow for OpenAPI/Swagger Client Generation #294

jimmypalelil opened this issue Jan 29, 2025 · 0 comments

Comments

@jimmypalelil
Copy link
Contributor

jimmypalelil commented Jan 29, 2025

Description

Create a GitHub workflow to automatically generate and update the client SDK from our NestJS Swagger implementation for the backend server app. This will ensure the client code stays in sync with our API changes.

Acceptance Criteria

  • Create a GitHub Actions workflow file that triggers on push and pull requests
  • Implement steps to auto generate client SDK using openapi-generator-cli
  • Add validation steps to ensure generated client is committed and up-to-date
  • Document the workflow process in the repository README
  • Setup pre-commit hooks for local development to check client generation

Additional context

  • Research and implement husky for pre-commit hooks
  • Consider adding validation steps to prevent commits if client is out of sync
  • Document local setup process for developers

Technical Requirements

  • GitHub Actions workflow configuration
  • Local development tools (e.g: husky)
  • Client generation scripts and configuration
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant