generated from coulomb/repo-seed
148 lines
2.4 KiB
Markdown
148 lines
2.4 KiB
Markdown
# Guide-Board Assessment Handoff
|
|
|
|
Status: draft
|
|
Updated: YYYY-MM-DD
|
|
|
|
## Assessment Intent
|
|
|
|
- Candidate software:
|
|
- Assessment purpose:
|
|
- Framework or extension:
|
|
- Environment:
|
|
- Non-goals:
|
|
- Known gaps:
|
|
|
|
## Candidate Startup
|
|
|
|
Working directory:
|
|
|
|
```sh
|
|
cd /path/to/candidate
|
|
```
|
|
|
|
Install or prepare:
|
|
|
|
```sh
|
|
# command here
|
|
```
|
|
|
|
Start service or generate artifact:
|
|
|
|
```sh
|
|
# command here
|
|
```
|
|
|
|
Readiness check:
|
|
|
|
```sh
|
|
# command here
|
|
```
|
|
|
|
Cleanup:
|
|
|
|
```sh
|
|
# command here, if needed
|
|
```
|
|
|
|
## Assessment Endpoint Or Artifact
|
|
|
|
- Kind: service endpoint | repository | file artifact | other
|
|
- URL or path:
|
|
- Protocol or binding:
|
|
- Expected readiness response:
|
|
- Mutation safety:
|
|
- Required headers:
|
|
|
|
## Guide-Board Profiles
|
|
|
|
- Guide-board repository:
|
|
- Extension repositories:
|
|
- Target profile:
|
|
- Assessment profile:
|
|
- Recommended output directory:
|
|
- Normal check groups:
|
|
- Approval-required check groups:
|
|
|
|
## Credentials And Secrets
|
|
|
|
- Credential reference:
|
|
- Credential owner:
|
|
- Minimum permission:
|
|
- Secret location:
|
|
- Rotation or cleanup:
|
|
- Artifact redaction notes:
|
|
|
|
## Expected Runtime State
|
|
|
|
- Required seeded data:
|
|
- Required dependent services:
|
|
- Network assumptions:
|
|
- Destructive-operation safeguards:
|
|
- Expected known gaps:
|
|
|
|
## CLI Run
|
|
|
|
```sh
|
|
cd /path/to/guide-board
|
|
PYTHONPATH=src python3 -m guide_board \
|
|
--extension-dir /path/to/extension \
|
|
run \
|
|
--target /path/to/target-profile.json \
|
|
--assessment /path/to/assessment-profile.json \
|
|
--output-dir /path/to/output-dir
|
|
```
|
|
|
|
## Local Service Run
|
|
|
|
Start guide-board service:
|
|
|
|
```sh
|
|
cd /path/to/guide-board
|
|
PYTHONPATH=src python3 -m guide_board \
|
|
--extension-dir /path/to/extension \
|
|
serve --host 127.0.0.1 --port 8080
|
|
```
|
|
|
|
Start assessment:
|
|
|
|
```sh
|
|
curl -sf -X POST http://127.0.0.1:8080/runs \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"target": "/path/to/target-profile.json",
|
|
"assessment": "/path/to/assessment-profile.json",
|
|
"output_dir": "/path/to/output-dir"
|
|
}'
|
|
```
|
|
|
|
Check status:
|
|
|
|
```sh
|
|
curl -sf http://127.0.0.1:8080/runs/JOB_ID
|
|
```
|
|
|
|
Fetch reports:
|
|
|
|
```sh
|
|
curl -sf http://127.0.0.1:8080/runs/JOB_ID/reports
|
|
```
|
|
|
|
## Result Review
|
|
|
|
Review first:
|
|
|
|
- `reports/report.md`
|
|
- `reports/assessment-package.json`
|
|
- `normalized/evidence.json`
|
|
- `normalized/findings.json`
|
|
- `retention-summary.json`
|
|
|
|
Candidate tracking:
|
|
|
|
- Workplan or issue tracker:
|
|
- Where report summaries are recorded:
|
|
- Candidate bug criteria:
|
|
- Known-gap criteria:
|
|
- Harness or environment issue criteria:
|
|
- Raw artifact retention:
|