Skip to content

Commit bdb5cc2

Browse files
authored
ci: clarify strict types generation in workflow (#475)
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.
1 parent 1be81d9 commit bdb5cc2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

.github/workflows/generate.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ jobs:
4747
- uses: SocketDev/socket-registry/.github/actions/setup-and-install@4709a2443e5a036bb0cd94e5d1559f138f05994c # main
4848

4949
- name: Generate SDK
50+
# Fetches OpenAPI, generates types/api.d.ts and src/types-strict.ts
5051
run: pnpm run generate-sdk
5152

5253
- name: Check for changes
@@ -93,11 +94,12 @@ jobs:
9394
9495
The OpenAPI definition in the API has been updated. This PR automatically:
9596
- Downloads the latest OpenAPI specification
96-
- Regenerates TypeScript types
97+
- Regenerates TypeScript types (types/api.d.ts)
98+
- Regenerates strict TypeScript types (src/types-strict.ts)
9799
- Updates SDK method signatures if needed
98100
99101
### What's Changed
100-
See the file changes below for specific updates to the API types and methods.
102+
See the file changes below for specific updates to the API types, strict types, and methods.
101103
102104
⚠️ **Please review carefully for any breaking changes in the API.**" \
103105
--label "dependencies" \

0 commit comments

Comments
 (0)