55 lines
2.4 KiB
Markdown
55 lines
2.4 KiB
Markdown
# CASAN DevKit (Level 2 — Adoption Kit)
|
|
|
|
Everything a new project needs to adopt the CASAN governance harness in a repeatable way.
|
|
**Level 2 = Level 1 core harness + adoption tooling.**
|
|
|
|
## Contents
|
|
| Path | Purpose |
|
|
|---|---|
|
|
| `install.sh` | Install core harness + `bin/casan` into a target repo, scaffold a domain, register it |
|
|
| `project-scaffold.py` | Create an idempotent production NestJS/React monorepo shell with manifest, CI, Docker and harness |
|
|
| `Dockerfile.harness` | Minimal image to run the gate on any mounted repo (`casan gate`) |
|
|
| `templates/domain-pack/` | Per-project domain scaffold (input / golden-runs / corpus / `domain-pack.yaml`) |
|
|
| `templates/gitea-workflow/ci.yml` | Reusable Gitea Actions gate workflow |
|
|
| `templates/project-shell/nestjs-react/` | Buildable/tested production project shell |
|
|
| `schemas/project-manifest.schema.json` | Versioned multi-project execution contract |
|
|
| `quality-profiles/enterprise-web-v1.json` | Shared quality floor and command allowlist |
|
|
|
|
## Create a new production shell
|
|
|
|
```bash
|
|
packages/casan-devkit/install.sh \
|
|
--target ../my-project \
|
|
--project ticketing \
|
|
--domain "Ticketing" \
|
|
--template nestjs-react
|
|
|
|
cd ../my-project
|
|
npm install
|
|
bin/casan project validate --manifest apps/ticketing/domain/project.manifest.json
|
|
bin/casan pipeline --manifest apps/ticketing/domain/project.manifest.json --dry-run
|
|
npm test && npm run build
|
|
```
|
|
|
|
The operation is fail-closed and idempotent: identical files are retained; a different existing
|
|
file aborts the run and is never overwritten. No generated command is passed through a shell.
|
|
|
|
## Quick adopt
|
|
```bash
|
|
# from a CASAN source hub or an extracted casan-devkit bundle
|
|
packages/casan-devkit/install.sh --target ../my-project --project ticketing --domain "Ticketing"
|
|
cd ../my-project
|
|
# add requirement + golden baseline under apps/ticketing/domain/, then:
|
|
CASAN_DOMAIN_ROOT=apps/ticketing/domain bin/casan gate
|
|
bin/casan reuse # HARNESS_REUSE_VALID
|
|
```
|
|
|
|
## Guides
|
|
- `docs/packaging/ADOPTION_GUIDE.md` — end-to-end adoption
|
|
- `docs/packaging/DOMAIN_PACK_GUIDE.md` — how to fill a domain pack
|
|
- `docs/packaging/CI_GUIDE.md` — wire the gate into Gitea CI
|
|
- `docs/packaging/DOCKER_GUIDE.md` — run/build the harness image
|
|
|
|
Adoption of an existing repository is **config + domain only**. New repositories can additionally
|
|
use the production project-shell template. In both modes, adopters never edit gate logic (H1→H7).
|