feat: add comprehensive documentation and CI/CD pipeline
- Add docs/ with ARCHITECTURE, ABSTRACTIONS, GETTING-STARTED, THEMING - Add GitHub Actions workflow with automated quality checks: • Tests (frontend + Rust) • Coverage (70% threshold) • Code Health (CodeScene delta analysis) • Documentation check (warning only) • Lint & Format (ESLint + Clippy + rustfmt) - Configure coverage in vite.config.ts (v8 provider, 70% threshold) - Add test:coverage script to package.json - Install @vitest/coverage-v8 - Update CLAUDE.md with docs-update requirement - Add CI/CD setup guides in .github/
This commit is contained in:
94
.github/workflows/README.md
vendored
Normal file
94
.github/workflows/README.md
vendored
Normal file
@@ -0,0 +1,94 @@
|
||||
# CI/CD Setup
|
||||
|
||||
## GitHub Actions Workflow
|
||||
|
||||
Il workflow `ci.yml` esegue i seguenti check automatici:
|
||||
|
||||
### 1. Tests
|
||||
- Frontend: `pnpm test`
|
||||
- Rust backend: `cargo test`
|
||||
|
||||
### 2. Test Coverage
|
||||
- Frontend: vitest con coverage reporting
|
||||
- Threshold configurabile in `vitest.config.ts`
|
||||
|
||||
### 3. Code Health (CodeScene)
|
||||
- Delta analysis su ogni PR/push
|
||||
- Fail se il code health diminuisce
|
||||
- Richiede secrets configurati (vedi sotto)
|
||||
|
||||
### 4. Documentation Check
|
||||
- Verifica che se cambia codice in `src/` o `src-tauri/`, anche `docs/` viene aggiornato
|
||||
- **Warning only** — non blocca il merge, solo un reminder
|
||||
- Skip con `[skip docs]` nel commit message
|
||||
- Aggiorna docs solo se la modifica invalida architettura/astrazioni/design già documentati
|
||||
|
||||
### 5. Lint & Format
|
||||
- ESLint per frontend
|
||||
- Clippy + rustfmt per Rust
|
||||
|
||||
## Setup Required
|
||||
|
||||
### CodeScene Secrets
|
||||
Aggiungi questi secrets nel repository GitHub (Settings → Secrets → Actions):
|
||||
|
||||
```
|
||||
CODESCENE_TOKEN=<your-codescene-pat>
|
||||
CODESCENE_PROJECT_ID=<your-project-id>
|
||||
```
|
||||
|
||||
Il PAT di CodeScene è lo stesso che usi localmente (~/.codescene/token).
|
||||
Il project ID lo trovi nella dashboard CodeScene.
|
||||
|
||||
### Coverage Thresholds
|
||||
Configura in `vitest.config.ts`:
|
||||
|
||||
```typescript
|
||||
export default defineConfig({
|
||||
test: {
|
||||
coverage: {
|
||||
lines: 80,
|
||||
functions: 80,
|
||||
branches: 80,
|
||||
statements: 80,
|
||||
// Fail CI se sotto threshold
|
||||
thresholds: {
|
||||
lines: 80,
|
||||
functions: 80,
|
||||
branches: 80,
|
||||
statements: 80
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## Local Testing
|
||||
|
||||
Prima di pushare, puoi testare localmente:
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
pnpm test && cargo test
|
||||
|
||||
# Check coverage
|
||||
pnpm test:coverage
|
||||
|
||||
# Lint
|
||||
pnpm lint
|
||||
cargo clippy
|
||||
cargo fmt --check
|
||||
|
||||
# CodeScene (local)
|
||||
codescene delta-analysis --base-revision origin/main
|
||||
```
|
||||
|
||||
## Workflow Triggers
|
||||
|
||||
- **Push**: su `main` e branch `experiment/*`
|
||||
- **Pull Request**: verso `main`
|
||||
|
||||
## Status Checks
|
||||
|
||||
Tutti i check devono passare prima di poter fare merge.
|
||||
Se un check fallisce, vedrai il dettaglio nei logs di GitHub Actions.
|
||||
Reference in New Issue
Block a user