Skip to content

Fix DTS snapshot validation in CI #879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bofeng-song wants to merge 6 commits into
base: main
Choose a base branch
from
+19 −1
Open

Fix DTS snapshot validation in CI #879

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1363eca
fix(ci): require generated DTS snapshot updates
bofeng-song Aug 21, 2026
2a5cc40
test
bofeng-song Aug 21, 2026
8ac3f8d
Revert "test"
bofeng-song Aug 21, 2026
8c4f7cc
test add
bofeng-song Aug 21, 2026
cb12675
ddd
bofeng-song Aug 21, 2026
006922d
revert
bofeng-song Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion .github/workflows/check-dts.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,29 @@ jobs:
shell: pwsh
run: npm run generate:dts:ci

- name: Verify generated DTS snapshot matches HEAD
shell: bash
run: |
SNAP_FILE="packages/cocos-cli-types/__tests__/__snapshots__/dts-snapshot.test.ts.snap"

# Regenerate the snapshot from the DTS files produced for this PR.
# A clean checkout alone is not sufficient: it may contain a snapshot
# committed before the latest API change.
npx jest --roots packages/cocos-cli-types --testPathPattern dts-snapshot --no-cache -u

if git diff --quiet HEAD -- "$SNAP_FILE"; then
echo "Generated DTS snapshot matches HEAD."
exit 0
fi

echo "::error file=$SNAP_FILE::Generated DTS snapshot differs from the latest committed snapshot. Run npm run generate:dts and commit the snapshot update."
git diff -- "$SNAP_FILE"
exit 1

- name: Run DTS tests
shell: bash
run: |
cp packages/engine/bin/.declarations/cc.d.ts packages/cocos-cli-types/cc.d.ts
npx jest --roots packages/cocos-cli-types --testPathPattern dts-snapshot --no-cache
npx eslint --fix "./packages/cocos-cli-types/*.d.ts"
npx jest packages/cocos-cli-types --roots="<rootDir>/packages/cocos-cli-types" --testPathIgnorePatterns dts-snapshot

Expand Down
Loading