新觅源码库
2.5 KiB
2.5 KiB
Validation Guide
Run the smallest relevant checks while iterating. Escalate to the broad checks when touching shared behavior, release automation, auth, persistence, or chat.
Always Run For PRs
npm run harness:check
For broad or shared changes, also run:
npm run test:coverage
npm run test:e2e
npm run build
Change-Type Matrix
| Change | Minimum local validation |
|---|---|
| Docs only | npm run harness:check |
| Client component/store/API | focused npm run test -- <pattern>, then npm run build |
| User-visible browser flow | focused Vitest plus npm run test:e2e |
| Server controller/service/db | focused npm run test -- tests/server/<file> |
| Auth, profile, or credential behavior | focused server tests plus relevant e2e auth tests |
| Chat, Socket.IO, group chat | focused server tests plus relevant e2e chat tests |
| Desktop packaging | npm run harness:check, npm run build, and a platform-specific desktop build when practical |
| 新觅源码库 workflow | npm run harness:check and actionlint when available |
| Package manifests | npm ci --ignore-scripts and lockfile workflow expectations |
CI Mapping
- Build workflow: installs dependencies, runs coverage, and builds production assets on pushes and pull requests.
- Playwright workflow: runs browser e2e tests.
- NPM lockfile workflow: verifies
package-lock.jsonis synchronized. - Desktop release and manual desktop build workflows build and upload platform-specific desktop artifacts.
- Docker workflow: builds and publishes release images.
Release Workflow Guardrail
Desktop release jobs must upload only the artifacts that their matrix target can
produce. Keep artifact globs in matrix data and keep fail_on_unmatched_files: true so missing expected files still fail.
Expected desktop release outputs:
| Target | Required release globs |
|---|---|
| macOS | *.dmg, *.dmg.blockmap, *.zip, *.zip.blockmap, latest*.yml |
| Windows | *.exe, *.exe.blockmap, latest*.yml |
| Linux x64 | *.AppImage, *.deb, latest*.yml |
| Linux arm64 | *.AppImage, latest*.yml |
Failure Handling
When a command fails:
- Read the first actionable error, not just the final stack trace.
- Check whether the failure indicates missing context, missing test coverage, or a missing mechanical rule.
- Fix the product bug when there is one.
- Update docs or
scripts/harness-check.mjswhen the same class of mistake should be prevented next time.