ci: clarify strict types generation in workflow #475
Merged
Conversation
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
jdalton
added
documentation
jdalton
changed the title
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.
jdalton
force-pushed
the
docs/clarify-strict-types-generation
branch
from
a9f47cb to
492db14
Compare
jdalton
changed the title
jwerle
approved these changes
Jan 26, 2026
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.
Summary
Updated the
generate.ymlworkflow documentation to explicitly mention that strict types are being generated.Changes
types/api.d.tsandsrc/types-strict.tsContext
The
pnpm run generate-sdkcommand already generates strict types viascripts/generate-sdk.mjs(step 3), but this wasn't documented in:This change makes it clear to reviewers that both type files are being regenerated when the OpenAPI definition changes.
Test plan
generate-sdk.mjsdoes callgenerateStrictTypes()(line 236)