More clean up
Some checks failed
Traceability Validation / Check Requirement Traces (push) Failing after 4s
🏗️ Build and Test JellyTau / Run Tests (push) Failing after 8m52s
🏗️ Build and Test JellyTau / Build Android APK (push) Has been skipped

This commit is contained in:
Duncan Tourolle 2026-06-20 15:38:26 +02:00
parent d5bca41c60
commit 0738ef10ec
17 changed files with 36 additions and 20 deletions

View File

@ -127,9 +127,9 @@ jobs:
run: |
echo ""
echo "📊 Full Report Generated"
echo "📁 Location: docs/TRACEABILITY.md"
echo "📁 Location: docs/traceability.md"
echo ""
head -50 docs/TRACEABILITY.md || true
head -50 docs/traceability.md || true
- name: Save artifacts
if: always()
@ -138,5 +138,5 @@ jobs:
name: traceability-reports
path: |
traces-report.json
docs/TRACEABILITY.md
docs/traceability.md
retention-days: 30

View File

@ -133,7 +133,7 @@ jobs:
uses: actions/upload-artifact@v3
with:
name: traceability-report
path: docs/TRACEABILITY.md
path: docs/traceability.md
retention-days: 30
- name: Comment PR with coverage report

View File

@ -27,6 +27,14 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
libssl-dev \
libclang-dev \
llvm-dev \
# Tauri Linux desktop dependencies (needed for `cargo test` on the host target)
libglib2.0-dev \
libgtk-3-dev \
libwebkit2gtk-4.1-dev \
libjavascriptcoregtk-4.1-dev \
libsoup-3.0-dev \
librsvg2-dev \
libayatana-appindicator3-dev \
&& rm -rf /var/lib/apt/lists/*
# Install Node.js 20.x from NodeSource

View File

@ -25,6 +25,14 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
libssl-dev \
libclang-dev \
llvm-dev \
# Tauri Linux desktop dependencies (needed for `cargo test` on the host target)
libglib2.0-dev \
libgtk-3-dev \
libwebkit2gtk-4.1-dev \
libjavascriptcoregtk-4.1-dev \
libsoup-3.0-dev \
librsvg2-dev \
libayatana-appindicator3-dev \
&& rm -rf /var/lib/apt/lists/*
# Install Node.js 20.x from NodeSource

View File

@ -13,7 +13,7 @@ The setup includes:
### Quick Start
**For CI/CD (Gitea Actions)**:
1. Build and push builder image (see [BUILD-BUILDER-IMAGE.md](BUILD-BUILDER-IMAGE.md))
1. Build and push builder image (see [build-builder-image.md](build-builder-image.md))
2. Push to master branch - workflow runs automatically
3. Check Actions tab for results and APK artifacts
@ -133,7 +133,7 @@ docker tag jellytau-builder:latest gitea.tourolle.paris/dtourolle/jellytau-build
docker push gitea.tourolle.paris/dtourolle/jellytau-builder:latest
```
See [BUILD-BUILDER-IMAGE.md](BUILD-BUILDER-IMAGE.md) for detailed instructions.
See [build-builder-image.md](build-builder-image.md) for detailed instructions.
### Setting Up Gitea Act

View File

@ -138,7 +138,7 @@ The workflow **warns** (but doesn't block) if:
3. Download **traceability-reports** artifact
4. View:
- `traces-report.json` - Raw trace data
- `docs/TRACEABILITY.md` - Formatted report
- `docs/traceability.md` - Formatted report
### Locally
```bash
@ -147,7 +147,7 @@ bun run traces:json | jq '.byType'
# Generate full report
bun run traces:markdown
cat docs/TRACEABILITY.md
cat docs/traceability.md
```
## Coverage Goals
@ -272,7 +272,7 @@ fi
- [Extract Traces Script](../scripts/README.md#extract-tracests)
- [Requirements Specification](../README.md#requirements-specification)
- [Traceability Matrix](./TRACEABILITY.md)
- [Traceability Matrix](./traceability.md)
- [Gitea Actions Documentation](https://docs.gitea.io/en-us/actions/)
## Support

View File

@ -27,7 +27,7 @@
"tauri": "tauri",
"traces": "bun run scripts/extract-traces.ts",
"traces:json": "bun run scripts/extract-traces.ts --format json",
"traces:markdown": "bun run scripts/extract-traces.ts --format markdown > docs/TRACEABILITY.md"
"traces:markdown": "bun run scripts/extract-traces.ts --format markdown > docs/traceability.md"
},
"license": "MIT",
"dependencies": {

View File

@ -68,7 +68,7 @@ Extract requirement IDs (TRACES) from source code and generate a traceability ma
```bash
bun run traces # Generate markdown report
bun run traces:json # Generate JSON report
bun run traces:markdown # Save to docs/TRACEABILITY.md
bun run traces:markdown # Save to docs/traceability.md
```
The script scans all TypeScript, Svelte, and Rust files looking for `TRACES:` comments and generates a comprehensive mapping of:
@ -82,7 +82,7 @@ Example TRACES comment in code:
function handlePlayback() { ... }
```
See [docs/TRACEABILITY.md](../docs/TRACEABILITY.md) for the latest generated mapping.
See [docs/traceability.md](../docs/traceability.md) for the latest generated mapping.
### CI/CD Validation
@ -93,8 +93,8 @@ The traceability system is integrated with Gitea Actions CI/CD:
- Generates traceability reports automatically
For details, see:
- [Traceability CI Guide](../docs/TRACEABILITY_CI.md) - Full CI/CD documentation
- [TRACES Quick Reference](../TRACES_QUICK_REF.md) - Quick guide for adding TRACES
- [Traceability CI Guide](../docs/traceability-ci.md) - Full CI/CD documentation
- [TRACES Quick Reference](../traces-quick-ref.md) - Quick guide for adding TRACES
## Utility Scripts

View File

@ -5,7 +5,7 @@
* Usage:
* bun run scripts/extract-traces.ts
* bun run scripts/extract-traces.ts --format json
* bun run scripts/extract-traces.ts --format markdown > docs/TRACEABILITY.md
* bun run scripts/extract-traces.ts --format markdown > docs/traceability.md
*/
import * as fs from "fs";

View File

@ -5,7 +5,7 @@
* beyond individual playback states. Enables persistent UI (miniplayer) and
* proper transitions between content types.
*
* See SoftwareArchitecture.md Section 2.1 for state machine diagram.
* See software-architecture.md Section 2.1 for state machine diagram.
*/
use log::info;

View File

@ -144,7 +144,7 @@ The workflow automatically checks:
- ✅ JSON format is valid
- ✅ Reports are generated
See [TRACEABILITY_CI.md](docs/TRACEABILITY_CI.md) for details.
See [traceability-ci.md](docs/traceability-ci.md) for details.
## Tips & Tricks
@ -198,8 +198,8 @@ A: Yes! TRACES show your implementation plan.
## See Also
- [Full Traceability Matrix](docs/TRACEABILITY.md)
- [CI/CD Pipeline Guide](docs/TRACEABILITY_CI.md)
- [Full Traceability Matrix](docs/traceability.md)
- [CI/CD Pipeline Guide](docs/traceability-ci.md)
- [Requirements Specification](README.md)
- [Extraction Script](scripts/README.md#extract-tracests)
@ -208,5 +208,5 @@ A: Yes! TRACES show your implementation plan.
**Quick Start:**
1. Add `// TRACES: UR-XXX` to new code
2. Run `bun run traces:markdown`
3. Check `docs/TRACEABILITY.md`
3. Check `docs/traceability.md`
4. Submit PR - workflow validates automatically!