[CORE-169] Orval sdk generation - #43
Merged
Merged
Conversation
elvisdragonmao
marked this pull request as ready for review
January 27, 2026 04:31
elvisdragonmao
requested review from
YukinaMochizuki and
Copilot
and removed request for
YukinaMochizuki
January 27, 2026 04:31
Contributor
There was a problem hiding this comment.
Pull request overview
This PR sets up automated SDK generation from TypeSpec/OpenAPI specifications using Orval. It introduces a monorepo structure with pnpm workspaces, creates a publishable npm package (@nycu-sdc/core-system-sdk), and establishes a CI/CD workflow for automated releases.
Changes:
- Configures Orval to generate a TypeScript SDK with fetch client from OpenAPI specs
- Creates
packages/sdkworkspace with TypeScript build configuration and npm package metadata - Adds Apache-2.0 LICENSE and GitHub Actions workflow for automated npm publishing
- Updates documentation with SDK usage examples and publishing instructions
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-workspace.yaml | Configures monorepo workspace structure |
| orval.config.js | Defines Orval SDK generation configuration |
| packages/sdk/package.json | npm package metadata for the published SDK |
| packages/sdk/tsconfig.json | TypeScript compiler configuration for SDK build |
| packages/sdk/README.md | SDK documentation with usage examples |
| package.json | Adds SDK generation script and orval dependency |
| .gitignore | Excludes generated SDK source files |
| .github/workflows/sdk.yml | CI/CD workflow for building and publishing SDK |
| LICENSE | Apache 2.0 license for the project |
| README.md, README.zh.md | Updated with SDK publishing instructions |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
elvisdragonmao
force-pushed
the
feat/CORE-169-Create-SDK
branch
from
January 27, 2026 12:06
ea8f187 to
bf3ef9d
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
YukinaMochizuki
requested changes
Jan 28, 2026
YukinaMochizuki
left a comment
Member
There was a problem hiding this comment.
Consider using English for the comments in files packages/sdk/tsconfig.json and scripts/patch-openapi.js for consistency
YukinaMochizuki
approved these changes
Jan 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type of changes
Purpose
Additional Information
https://www.npmjs.com/package/@nycu-sdc/core-system-sdk