Docs: add "Using Environment Variables". #2188
Merged
Conversation
This file contains 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
Michaelvll
approved these changes
Jul 7, 2023
There was a problem hiding this comment.
Thanks for adding this @concretevitamin! It is very important to keep track of the environment variables we have.
Comment on lines
42
to
50
| Using in ``setup`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| All user-specified environment variables are exported to a task's ``setup`` commands. | ||
|
|
||
| Using in ``run`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| All user-specified environment variables are exported to a task's execution (i.e., while its ``run`` commands are running). |
There was a problem hiding this comment.
Maybe we can combine the two sections into one to reduce the duplication.
Using in ``setup`` and ``run``
| If a task is run as a :ref:`managed spot job <spot-jobs>`, then all | ||
| recoveries of that job will have the same ID value. Read more :ref:`here <spot-jobs-end-to-end>`. | ||
| - sky-2023-07-06-21-18-31-563597_myclus_id-1 | ||
|
|
There was a problem hiding this comment.
There are a bunch more env vars added by the #2106, but it should be fine to leave it out, as that feature is still experimental.
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.
Tested (run the relevant ones):
bash format.shpytest tests/test_smoke.pypytest tests/test_smoke.py::test_fill_in_the_namebash tests/backward_comaptibility_tests.sh