Skip to content

development.md

Latest commit

 

History

History
107 lines (72 loc) · 2.61 KB

development.md

File metadata and controls

107 lines (72 loc) · 2.61 KB

Development

This doc covers local verification, smoke testing, packaging, and release steps for this repo itself.

Local Verify

Primary checks:

npm run verify
PYTHONPATH=source/src python3 -m story_automator --help

npm run verify expands to:

  • npm run test:python
  • npm run pack:dry-run
  • npm run test:smoke

Smoke Test Coverage

The smoke suite validates:

  • installer behavior
  • packed npx install behavior from the generated tarball
  • required and optional dependency handling
  • legacy backup behavior
  • installed skill layout
  • installed runtime policy, prompt templates, and parse contracts
  • prompt-building behavior for Claude and Codex child sessions

Repo Verification Flow

flowchart TD
    A["Edit installer, payload, or runtime"] --> B["Run npm run test:python"]
    B --> C["Run npm run pack:dry-run"]
    C --> D["Run npm run test:smoke"]
    D --> E["Run npm run verify"]
Loading

Packaging Surface

Important package parts:

  • bin/bmad-story-automator
  • install.sh
  • payload/
  • source/
  • README.md
  • ref.png

The published package bundles both the install payload and the Python runtime source.

Runtime Entry During Development

The shell wrapper used in installed projects is mirrored in this repo:

source/scripts/story-automator

It runs:

python3 -m story_automator

with PYTHONPATH pointed at source/src.

Legacy Env Compatibility

For one release cycle, fresh orchestration starts still honor:

  • MAX_REVIEW_CYCLES
  • MAX_CRASH_RETRIES

Those values are resolved once during snapshot creation. Resume paths read the pinned snapshot, not the current shell env. Prefer _bmad/bmm/story-automator.policy.json for new configuration changes.

What To Re-Check After Runtime Changes

If you change:

  • commands/tmux.py: re-check spawn, command building, monitor behavior, Codex vs Claude handling
  • commands/orchestrator.py: re-check state summary, marker behavior, sprint-status verification
  • install.sh: re-check dependency validation, copy layout, backups, shim cleanup
  • payload step files: re-check docs, prompts, and smoke expectations

Release

Publish steps:

  • npm adduser
  • npm publish

Recommended release checklist:

  1. npm run verify
  2. use $secrets for npm auth material; search exact key names, then secrets load <KEY> into the publish shell; never print token values
  3. inspect the package dry-run output
  4. confirm README and docs match shipped behavior
  5. publish

Read Next