Versioning of the template

[mihai-sysbio]

Thinking of the long term compatibility of the template, how is versioning of the lesson template envisioned to be handled?

[GeertvanGeest]

If there's a template that is 'production-ready' (should be soon), I'd say we start by using version tags. Other than that there's no vision. Happy to hear suggestions!

[joseale2310]

You can use releases for versioning. If you would link the template repo to Zenodo, each release of the template will have assigned a permanent and unique DOI that can be citable, that would be also really helpful.

Finally, there is a tool that allows deployment of different versions of the webpage: https://github.com/jimporter/mike Find an example here: https://squidfunk.github.io/mkdocs-material-example-versioning/0.3/

[GeertvanGeest]

Using mike is pretty powerful; we use it all the time for SIB courses (e.g. https://sib-swiss.github.io/single-cell-training/2023.3/). However, I never got to it to write an action that runs after a git tag (= a gh release) is given and pushes a new version with mike. Would be nice to have one.

[GeertvanGeest]

An example of an action is referenced here: https://github.com/jimporter/mike/issues/79

[mihai-sysbio]

Actually, my initial point was about how to manage new release of the template repo in connection with the already-developed lessons. I guess a GH Action is the way to go, but that would have to be set up with a schedule, since the template might update even if the lesson doesn't.

[joseale2310]

I believe we have another issue regarding this? #13

[mihai-sysbio]

It certainly looks that way; my suggestion would be to close one of the issues (this one or #13).

[GeertvanGeest]

Closing this issue, add versioning with mike as new issue in #18