From 492db14c8ecfeb0f94e71c21a5bf3ed89d116f81 Mon Sep 17 00:00:00 2001 From: jdalton Date: Mon, 26 Jan 2026 18:03:16 -0500 Subject: [PATCH] ci: clarify strict types generation in workflow Update generate.yml workflow documentation to explicitly mention that strict types (src/types-strict.ts) are generated alongside standard types (types/api.d.ts) when the OpenAPI definition is synced. The generation was already happening via generate-sdk.mjs, but wasn't documented in the workflow comments or PR description template. --- .github/workflows/generate.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/generate.yml b/.github/workflows/generate.yml index 50bcf466..3d20d9ed 100644 --- a/.github/workflows/generate.yml +++ b/.github/workflows/generate.yml @@ -47,6 +47,7 @@ jobs: - uses: SocketDev/socket-registry/.github/actions/setup-and-install@4709a2443e5a036bb0cd94e5d1559f138f05994c # main - name: Generate SDK + # Fetches OpenAPI, generates types/api.d.ts and src/types-strict.ts run: pnpm run generate-sdk - name: Check for changes @@ -93,11 +94,12 @@ jobs: The OpenAPI definition in the API has been updated. This PR automatically: - Downloads the latest OpenAPI specification - - Regenerates TypeScript types + - Regenerates TypeScript types (types/api.d.ts) + - Regenerates strict TypeScript types (src/types-strict.ts) - Updates SDK method signatures if needed ### What's Changed - See the file changes below for specific updates to the API types and methods. + See the file changes below for specific updates to the API types, strict types, and methods. ⚠️ **Please review carefully for any breaking changes in the API.**" \ --label "dependencies" \