Document recommended workflow for updating version.json

[AArnott]

As @onovotny suggested, there should be documentation guiding the how, when, and where of updating version.json files around releases, servicing branches, etc.

[josesimoes]

To make this more efficient it would be even better if the version could bump itself.
Kind of the way gitversion works: have a config for the version and option to bump major/minor/revision on a tag, or on release, or from a build parameter/variable.

I mean having to manually edit the version.json on each "release" and after that on the next iteration on "develop" is a bit cumbersome and not very efficient considering that you have to commit, push, pull, etc.

[AArnott]

@josesimoes NB.GV intentionally requires a commit to be authored to change the version. Merely branching or tagging is not an input into this process because such things can come and go in git, making it difficult to come back later and ascertain which commit built a particular version, or what version a commit was built with. This is perhaps the most distinguishing characteristic between GitVersion and NB.GV that to me justifies the two competing libraries -- people have their preferences on this and can choose which one to use, but where GitVersion prioritizes auto-versioning, NB.GV prioritizes repeatable, deterministic builds and servicing.

That said, #287 tracks a suggestion that will likely be implemented very soon that streamlines the process of updating version.json for releases that might interest you.

[josesimoes]

I can fully understand what you've just describe and that makes sense. Just peeked #287 and I believe something like what's being discussed over there would be a real helper on handling this more efficiently.

In the mean time (as this issue is all about) a more detailed description on the intended/expected workflow around version.json would be very helpful.

[LoremFooBar]

I'm sorry to bump this old issue... As a new user, I find the documentation to be somewhat overwhelming. It will be very helpful if the documentation guides new users on the recommended usage in terms of installation, branching, updating version.json, CI flow, etc.