Release¶
Versioning¶
cpmdc uses semantic versioning on the public C ABI and Cap’n Proto schema
fields.
Additive Cap’n Proto fields and new ABI entry points are minor; breaking field
renumbers or ABI signature changes are major.
The version is the single line of the root version.txt, and no other file
carries a hand-written copy.
Meson reads it with files(), and docs/source/conf.py reads it for the
Sphinx version and release.
pixi run version-sync regenerates the cog copies in pixi.toml,
include/cpmdc.h, the Doxygen configuration, and the first-energy tutorial.
pixi run release-assert fails when one of them differs from version.txt.
The first cocogitto pre-bump hook writes the new version to version.txt and
then regenerates the copies.
Checklist¶
Run
meson test -C build --print-errorlogson the default parser/session configuration.Run
pixi run -e docs sphinxbldafter documentation or public header changes.Run the OpenCPMD archive suite when the release changes the embed path:
CPMDC_PSEUDO_DIR=/path/to/PP_LIBRARY meson test -C build-cpmd --print-errorlogs.Confirm
cpmdc_feature_table()exposes any new ABI, schema, section, or keyword capability.Update
CHANGELOG.mdfor user-visible changes.Tag
vX.Y.Zwhen publishing.
0.1 covers the Cap’n Proto structure, C ABI, ISOCembed shell, stub/reference backend, and archive-linked OpenCPMD energy/force path.