SDK typechecks in CI #577
Closed
SDK typechecks in CI #577
Conversation
This file contains 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
oliverlaz
approved these changes
May 16, 2024
szuperaz
approved these changes
May 17, 2024
|
As discussed with @tbarbugli, I'll try moving this check closer to the source of truth - GetStream/chat in this instance. |
|
Superseded by https://github.com/GetStream/chat/pull/6513 |
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.
To prevent accidentally introducing a breaking change to the OpenAPI spec, we can run type checks on our JS clients. If types break in the client, it signals a breaking change in the API. That's not necessarily bad, but something to be aware of.
Here's how it works:
Note how "SDK Typecheck" check is red in this PR. That's because there's been a lot of breaking changes in the spec since we last bumped it in the SDK. After merging GetStream/stream-video-js#1343 this check will be green (as proven by a test run).
Revert changes to
openapi/video-openapi-clientside.yamlbefore merging!