Improve configuration environment variable docs - #2189
Open
JeanChristopheMorinPerso wants to merge 4 commits into
Open
Improve configuration environment variable docs#2189JeanChristopheMorinPerso wants to merge 4 commits into
JeanChristopheMorinPerso wants to merge 4 commits into
Conversation
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a02b3d-dd38-7533-abe8-4844dadda902
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2189 +/- ##
==========================================
+ Coverage 61.29% 61.31% +0.01%
==========================================
Files 164 164
Lines 20568 20577 +9
Branches 3575 3576 +1
==========================================
+ Hits 12607 12616 +9
Misses 7089 7089
Partials 872 872 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a02b3d-dd38-7533-abe8-4844dadda902
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com> Amp-Thread-ID: https://ampcode.com/threads/T-019fd984-bbd8-750e-8a0e-7f10d664a703
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com> Amp-Thread-ID: https://ampcode.com/threads/T-019fd984-bbd8-750e-8a0e-7f10d664a703
Contributor
|
Is it worth adding a new test that guards against any Setting subclass referenced in config_schema that doesn't set |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We've had a gap for years now in regards to config settings environment variables. I partly filled that gap when I introduced https://rez.readthedocs.io/en/stable/environment.html and the automatic documentation of env vars in settings (https://rez.readthedocs.io/en/stable/configuring_rez.html#envvar-REZ_CONTEXT_TMPDIR), but there was still a major missing piece.
Some of our settings can only be configured via an environment variable suffixed with
_JSON.This PR properly documents those and also documents that all settings be set via
REZ_XXX_JSON. I also took the occasion to document the format of some env vars too.With this, I think we can finally say that all our settings and env vars are properly documented. At least I think, until someone comes in to tell me that we missed something 😄
Lastly, I also fixed an old bug that was triggered when a user was setting a setting via an env var but without the JSON suffix for a setting that only supports JSON. Rez was raising a fat from helpful
NotImplementedError. With the fix, rez raises an actionable exception.Amp-Thread-ID: https://ampcode.com/threads/T-01a02b3d-dd38-7533-abe8-4844dadda902