61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
# Step 10: release-readiness-note
|
|
|
|
## Read These Files First
|
|
|
|
Read the following files before editing:
|
|
|
|
- `/AGENTS.md`
|
|
- `/docs/PRD.md`
|
|
- `/docs/ADR.md`
|
|
- `/docs/releases/README.md`
|
|
- `/docs/requirements/euler-beam-3d.md`
|
|
- `/docs/io-definitions/euler-beam-3d-io.md`
|
|
- `/docs/reference-models/euler-beam-3d-reference-models.md`
|
|
- `/docs/build-test-reports/euler-beam-3d-build-test.md`
|
|
|
|
## Task
|
|
|
|
Create `/docs/releases/euler-beam-3d-release.md`.
|
|
|
|
This is a readiness note, not a release approval. It must state:
|
|
|
|
- status: `not-release-ready-kernel-increment-complete` unless all upstream gates and reference artifacts somehow exist
|
|
- completed scope: local/global stiffness and end-force kernel for two-node 3D Euler-Bernoulli beam
|
|
- missing for full feature release:
|
|
- parser implementation for the approved Abaqus subset
|
|
- section/property semantic model integration
|
|
- assembler/static solver integration
|
|
- HDF5 result emission for beam quantities
|
|
- stored Abaqus reference artifacts
|
|
- reference comparison report
|
|
- physics sanity report
|
|
- known limitations from requirements
|
|
- next recommended phase or phase dependencies
|
|
|
|
Do not change source or tests in this step.
|
|
|
|
## Tests To Write First
|
|
|
|
- No C++ test is required in this documentation-only step.
|
|
|
|
## Acceptance Criteria
|
|
|
|
```powershell
|
|
python -m unittest discover -s scripts -p "test_*.py"
|
|
python scripts/validate_workspace.py
|
|
```
|
|
|
|
## Verification Notes
|
|
|
|
1. Confirm the note does not claim full release readiness.
|
|
2. Confirm all missing gates are explicit.
|
|
3. Update `phases/euler-beam-3d/index.json` step 10:
|
|
- success: `"status": "completed"`, `"summary": "3D Euler beam release readiness note added"`
|
|
- failure after retries: `"status": "error"`, `"error_message": "<specific error>"`
|
|
- blocked: `"status": "blocked"`, `"blocked_reason": "<specific reason>"`
|
|
|
|
## Forbidden
|
|
|
|
- Do not create or modify reference artifacts.
|
|
- Do not modify source, tests, requirements, formulations, or I/O contracts.
|