Repository navigation
fix(checks): run check:generated from checks:prepare - #8
Merged
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
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.
Why
pnpm run checksmust fail whensdk/src/generated/cloud-api.tsis stale againstsdk/openapi/cloud.openapi.yaml. Onboarding (#5) replaced thechecksscript withantelopejs-checks, which does not runcheck:generated, so a stale client passed locally (ANT-2004). tooling-configs#304 now reports such dropped steps, but this repository was migrated before it.What changes
package.jsonaddschecks:prepare, which runscheck:generated.antelopejs-checksrunschecks:preparebefore its other steps and stops if it fails. Generation rewrites a file thattypecheckandlintread, so it runs first instead of beside them..github/workflows/ci.ymldropspnpm run check:generatedfromextra-commands. CI's checks job runspnpm run checks, which now runs it.Proof
The spec gets one new optional field,
hintonError, and the generated client is not regenerated. Thenpnpm run checksruns from the repository root. Both files are restored afterwards.Before (
main):After (this branch):
On a clean tree, this branch prints
Checks: 11 passed, 0 failed.,sync:checkincluded.Attention
checksbefore the other steps run. Rerun afterpnpm --dir sdk run generate.