Skip to content

[CORE-169] Orval sdk generation - #43

Merged
YukinaMochizuki merged 19 commits into
mainfrom
feat/CORE-169-Create-SDK
Jan 28, 2026
Merged

[CORE-169] Orval sdk generation#43
YukinaMochizuki merged 19 commits into
mainfrom
feat/CORE-169-Create-SDK

Conversation

@elvisdragonmao

Copy link
Copy Markdown
Collaborator

Type of changes

  • Generate SDK
  • Create monorepo structure
  • Add LICENSE

Purpose

  • For front-end team to use.

Additional Information

https://www.npmjs.com/package/@nycu-sdc/core-system-sdk

@elvisdragonmao elvisdragonmao changed the title Orval sdk generation [CORE-169] Orval sdk generation Jan 27, 2026
@elvisdragonmao
elvisdragonmao marked this pull request as ready for review January 27, 2026 04:31
@elvisdragonmao
elvisdragonmao requested review from YukinaMochizuki and Copilot and removed request for YukinaMochizuki January 27, 2026 04:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/sdk workspace 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.

Comment thread .github/workflows/sdk.yml Outdated
Comment thread orval.config.js
Comment thread packages/sdk/package.json
Comment thread packages/sdk/package.json
Comment thread package.json Outdated
Comment thread packages/sdk/README.md Outdated
Comment thread packages/sdk/tsconfig.json
Comment thread .github/workflows/sdk.yml Outdated
Comment thread .github/workflows/sdk.yml
Comment thread packages/sdk/README.md Outdated
@elvisdragonmao
elvisdragonmao force-pushed the feat/CORE-169-Create-SDK branch from ea8f187 to bf3ef9d Compare January 27, 2026 12:06
elvisdragonmao and others added 5 commits January 27, 2026 22:25
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

@YukinaMochizuki YukinaMochizuki left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using English for the comments in files packages/sdk/tsconfig.json‎ and scripts/patch-openapi.js‎ for consistency

@YukinaMochizuki
YukinaMochizuki merged commit 021a626 into main Jan 28, 2026
2 checks passed
@YukinaMochizuki
YukinaMochizuki deleted the feat/CORE-169-Create-SDK branch January 28, 2026 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants