cpitclaudel / alectryon

A collection of tools for writing technical documents that mix Coq code and prose.
MIT License
228 stars 36 forks source link

Support/Dependency versions for Coq 8.11 and 8.12 #7

Closed Blaisorblade closed 3 years ago

Blaisorblade commented 3 years ago

Congrats on the release! I was upgrading our code to Coq 8.12, and was wondering whether that's supported — the README doesn't say.

cpitclaudel commented 3 years ago

Thanks :)

I've been cautious about making claims about supported versions mostly because I haven't set up a CI yet; I'd love help with that if you or someone who comes across this issue has time :)

IIUC SerAPI's versioning scheme is that version X.Y+ of SerAPI corresponds to version X.Y. of coq. My plan is mostly to follow SerAPI in deciding what's supported, so at the moment with Alectryon you'd use latest SerAPI 8.10+, 8.11+, or 8.12+*, and all three should work. Would it help to be more precise than this (promising to support not just SerAPI X.Y+latest but SerAPI X.Y+Z for a specific Z?)

(One note: I want to start passing -topfile soon, but since Emilio released a new version of SerAPI 8.10 with that feature it shouldn't break anything beyond requiring a SerAPI update from 8.10.0+0.7.0 to 8.10.0+0.7.1).

Blaisorblade commented 3 years ago

Until there’s CI, "We hope that we support Coq 8.10-8.12 but for now we only test 8.10" would prevent these questions. (I'd guess we used 8.11+0.11.0 plenty?).

On help for CI, I don’t have time right now, so I don't want to overpromise.

Would it help to be more precise than this (promising to support not just SerAPI X.Y+latest but SerAPI X.Y+Z for a specific Z?)

I’d indeed pick that Z that you recommend: AFAIK we’re devout Alectryon followers, so we only use serapi for Alectryon and no other gods 🙃 . And we’ll install whichever SerAPI version Alectryon recommends.

Considering other users, not sure what’s reasonable for you to support — it’s currently your time. The docs should reflect what you do I guess? Say, after a new SerAPI release, is it supported immediately or do you need to test the code? In the latter case, you could bump the README after you do the testing.

Zimmi48 commented 3 years ago

Despite what it README claims, SerAPI is pretty stable so I wouldn't be surprised if the claim "all versions above X" was sufficient.

cpitclaudel commented 3 years ago

Done, I've updated the readme to say ≥ 8.10. I've also relaxed the version list for Python packages.