Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document what priority/order is used for version selection #133

Open
creeder-uturn opened this issue May 15, 2024 · 3 comments
Open

Document what priority/order is used for version selection #133

creeder-uturn opened this issue May 15, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@creeder-uturn
Copy link

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
Copy link
Author

creeder-uturn commented May 15, 2024

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 😄

@kvendingoldo kvendingoldo added the documentation Improvements or additions to documentation label May 16, 2024
@dvaumoron
Copy link
Contributor

dvaumoron commented May 16, 2024

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)

@creeder-uturn
Copy link
Author

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants