Versioning

[ppdewolf]

Because document is "live" document, need to find out how to include the version number / time stamp to the first page of the handbook, online as well as pdf, updated at each html-rendering.

I'm thinking about using a versioning system like

version 2.0.0 (current version of second edition)
Automatically adding to the last digit whenever the handbook is rendered following a new commit to the main branch. (i.e. next will be 2.0.1 then 2.0.2, etc) Can this be done automatically with each commit and then appear in the document?

Adding to the second digit by hand when a major change is applied (e.g., going from 2.0.31 to 2.1.0).

[julienjamme]

This is a good idea, but perhaps not every commit on the main branch deserves a new version number.

One solution, which isn't completely automatic, would be to make the book version number depend on the commit tag number: whenever a commit on the main branch is accompanied by a version tag, the tag would also be used as the version number.

In this way, we keep control over numbering.

What do you think ?

I'm not sure it's easy to do, but I'll make some research.

EDIT: Actually, maybe we could render and deploy a new version of the book only on tagged commits.

[ppdewolf]

Just read your edit: that would perhaps be an option. That way there are only "registered" releases (rendered and deployed).

Question: I guess when there is a pull request that we accept, that will produce a commit to which we can still assign a tag when we think it should have a tag to update the version numbering?

Only disadvantage I could think of is that when a pull request is accepted from person X and we have not added a tag, person X nor others would easily see the changes (no deployment).