New harness adapter authoring¶
Use this runbook when authoring a new harness adapter for first-party inclusion in apothem or as a third-party package.
Prerequisites¶
- Familiarity with the HarnessAdapter protocol
- Understanding of the target harness config format
- Python 3.10+
Steps¶
1. Implement the adapter¶
Follow the Authoring a harness adapter
example to implement HarnessAdapter for the target harness.
2. Write the docs page¶
Create docs/harnesses/<slug>.md covering:
- Installation flow
- Profile-to-native-config mapping
- Compatibility caveats
- Verification recipes
- Update and uninstall recipes
- Conformity gate surface
- Troubleshooting table
- Configuration knobs table
3. Write tests¶
tests/packaging/test_<slug>_adapter.py
tests/unit/test_<slug>_adapter.py
Minimum test coverage:
- test_install_creates_expected_files
- test_verify_passes_after_install
- test_uninstall_removes_files
4. Verify locally¶
apothem install --harness <slug>
apothem verify --harness <slug>
python src/apothem/conformity/conformity-gate.py --harness <slug>
5. Submit pull request¶
Open a PR with:
- Adapter implementation
- Docs page at
docs/harnesses/<slug>.md - Tests
- Entry-point registration in
pyproject.toml - Changelog entry