Been building pyopia-gui against PyOPIA the last few days and ran into
something worth talking about before we next catch up.
The Docker support (Dockerfile, docs, compose.yaml) has been sitting on main
since before v2.0.3 (back in Sep 2024) but never made it into an actual
release, and the image itself was never published by CI either (#424). So
anyone outside our GH org trying to follow the README's docker instructions
just hits a wall - it looks finished and documented but isn't actually usable.
Two things I think are worth changing:
- Cut releases when something's actually done, not on a fixed schedule. If a
feature (like the Docker stuff) is finished, it should go in the next
release rather than sit around indefinitely.
- The Docker image publish should be part of the release process itself, not
a separate manual step - otherwise it just drifts out of sync, which is
basically what happened here.
Also worth considering: a Zenodo DOI per release. It's free and basically
automatic once the repo's linked, and since people cite PyOPIA in papers,
having an exact citable version (rather than "whatever main was on some
random date") seems worth doing.
Nothing urgent, just want to get this on the radar before we talk.
Been building pyopia-gui against PyOPIA the last few days and ran into
something worth talking about before we next catch up.
The Docker support (Dockerfile, docs, compose.yaml) has been sitting on main
since before v2.0.3 (back in Sep 2024) but never made it into an actual
release, and the image itself was never published by CI either (#424). So
anyone outside our GH org trying to follow the README's docker instructions
just hits a wall - it looks finished and documented but isn't actually usable.
Two things I think are worth changing:
feature (like the Docker stuff) is finished, it should go in the next
release rather than sit around indefinitely.
a separate manual step - otherwise it just drifts out of sync, which is
basically what happened here.
Also worth considering: a Zenodo DOI per release. It's free and basically
automatic once the repo's linked, and since people cite PyOPIA in papers,
having an exact citable version (rather than "whatever main was on some
random date") seems worth doing.
Nothing urgent, just want to get this on the radar before we talk.