feat: Documentation audit for stackchain-dashboard #23

Merged
rockachopa merged 1 commits from timmy/19-documentation-audit-for-stackchain-dashboard into main 2026-08-04 15:03:07 +00:00
2 changed files with 25 additions and 5 deletions

View File

@ -20,16 +20,24 @@ python3 -m src.release_engine \
--dry-run
```
Execute one ticket:
Execute one ticket after implementing and committing its change directly on
the deterministic branch printed by `--dry-run`:
```bash
export RELEASE_AGENT_COMMAND='codex exec "Implement Gitea issue #{issue_number}: {issue_title}. Follow the issue body and run tests."'
export GITEA_TOKEN='<scoped-token>'
export RELEASE_AGENT_COMMAND=true
python3 -m src.release_engine \
--repo stackchain/stackchain-dashboard \
--agent timmy \
--issue 19 \
--test-command 'python3 -m pytest tests/ -q'
```
Required secret: `GITEA_TOKEN`. Durable state defaults to
`.release-engine/state.json`. Full behavior and safety gates are documented in
[`docs/release-engine-spec.md`](docs/release-engine-spec.md).
`GITEA_TOKEN` needs issue and repository write scopes. The engine verifies the
claim, reruns the test command, pushes the branch, and opens a PR containing
`Closes #19` plus test evidence. Replace `19` with the selected issue number;
do not run without `--issue` when processing a preselected ticket.
Durable state defaults to `.release-engine/state.json`. Full behavior and
safety gates are documented in
[`docs/release-engine-spec.md`](docs/release-engine-spec.md).

12
tests/test_readme.py Normal file
View File

@ -0,0 +1,12 @@
from pathlib import Path
README = Path(__file__).parents[1] / "README.md"
def test_release_worker_instructions_use_direct_agent_execution():
text = README.read_text()
assert "codex" not in text.lower()
assert "RELEASE_AGENT_COMMAND=true" in text
assert "--issue 19" in text