Skip to content

AGENTS.md

Latest commit

 

History

History
28 lines (21 loc) · 1.11 KB

AGENTS.md

File metadata and controls

28 lines (21 loc) · 1.11 KB

Repository agent notes

Protocol regeneration (Avlos)

The files include/tinymovr/tinymovr.hpp, include/tinymovr/helpers.hpp and src/tinymovr/tinymovr.cpp are generated by Avlos from a Tinymovr protocol spec. Do not hand-edit them; regenerate instead.

To regenerate, install Avlos in any Python environment and run it against the desired spec:

pip install avlos
avlos from file <path-to>/tinymovr_<version>.yaml --config=./avlos_config.yaml

Specs live in the Tinymovr repository under studio/Python/tinymovr/specs/ (e.g. tinymovr_3_0_x.yaml). The generator config in this repo is avlos_config.yaml; it controls which files Avlos writes.

Release flow

  1. Branch off main (e.g. update_protocol_<ver>).
  2. Regenerate the protocol sources with Avlos using the appropriate spec.
  3. Bump <version> in package.xml.
  4. Update RELEASE_NOTES.md.
  5. Open a PR into main. After merge, tag the release on main as vX.Y.Z-ros2-jazzy and create a matching GitHub Release.