Skip to content

CI and Quality Checks

This page describes practical CI layers for an open-source repository. Some checks may initially run manually or on self-hosted runners until public infrastructure is ready.

LayerCommand / EntryNotes
Documentationnpm ci, npm run docs:buildVerifies VitePress pages and links.
Frontendfrontend package scriptsConfirm exact command under src/web/.
C++ formattingscripts/format_check.sh --checkRequires clang-format.
C++ static analysisscripts/static_analysis.sh --cppcheck, scripts/static_analysis.sh --clang-tidyclang-tidy needs compile_commands.json.
CPU build/testsCPU build scripts and test targetGood first public CI candidate.
Release packageSophon package scriptMay require self-hosted runner and SDK.

Documentation

bash
npm ci
npm run docs:build

On Windows PowerShell, use npm.cmd run docs:build if script execution policy blocks npm.ps1.

Release Checks

Release validation should verify package layout, executable startup, web console availability, service ports, resource loading, and sensitive-data scan results.

Released under the Apache 2.0 License.