tenv icon indicating copy to clipboard operation
tenv copied to clipboard

Document what priority/order is used for version selection

Open creeder-uturn opened this issue 1 year ago • 3 comments

Right now, I cannot find clear documentation on which order version detection uses. There is a decent listing of which things can be looked at, but it's not immediately obvious which have priority.

It'd be great if the documentation have a section that clearly indicated that order.

If I've missed it feel free to clown on me 😄

creeder-uturn avatar May 15 '24 16:05 creeder-uturn

It seems like the following order is used, but I've not tested thoroughly:

  • Project version file
  • Version file in Project Root (Possibly one anywhere in the tree above the project in order?)
  • Default system-wide version defined

Notably missing: the requirements listed in the TF files, which can be installed/used with latest-allowed and min-required but it doesn't seem like this is used automatically as a fallback?

If the strict ordering is confirmed, I may be willing to PR the documentation changes 😄

creeder-uturn avatar May 15 '24 16:05 creeder-uturn

The project binaries part of the README indicate the version resolution order for each binary.

However, it need a better highlighting and some clarification (on the walking tree order, I talk about it there)

dvaumoron avatar May 16 '24 15:05 dvaumoron

Oh, awesome! I didn't see the version resolution order. That's precisely what I was looking for.

I would propose sending that information into a digestible section with version files, or perhaps it's own section.

Weary to make promises I may not deliver but I will probably take a stab at a PR with what I imagine (and I can try to clarify better, too).

creeder-uturn avatar May 16 '24 17:05 creeder-uturn