feat: CLI options can be supplied using env vars #18
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
Although sbatch already allows providing values for options through SBATCH_ prefixed env vars, not all options are supported. This change adds support for all options of sbatch through a GRIDTK_SUBMIT_ prefix. For example, to always get emails when a job finishes, you can set GRIDTK_SUBMIT_MAIL_USER to your email address and GRIDTK_SUBMIT_MAIL_TYPE to END. This is useful when you have a set of options that you always want to use, but don't want to specify them every time you submit a job.
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||||||||||||||
183amir
commented
Mar 6, 2025
| @@ -16,3 +16,6 @@ python: | |||
| path: . | |||
| extra_requirements: | |||
| - doc | |||
|
|
|||
| sphinx: | |||
| configuration: doc/conf.py | |||
There was a problem hiding this comment.
sgaist
approved these changes
Mar 6, 2025
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.
Although sbatch already allows providing values for options through SBATCH_ prefixed env vars, not all options are supported. This change adds support for all options of sbatch through a GRIDTK_SUBMIT_ prefix. For example, to always get emails when a job finishes, you can set GRIDTK_SUBMIT_MAIL_USER to your email address and GRIDTK_SUBMIT_MAIL_TYPE to END. This is useful when you have a set of options that you always want to use, but don't want to specify them every time you submit a job. Of course, other gridtk commands such as
gridtk resubmitoptions can also be set using environment variables like:export GRIDTK_RESUBMIT_STATE=ALL.fix: explicitly speficy the sphinx.configuration key in Read the Docs setup
📚 Documentation preview 📚: https://gridtk--18.org.readthedocs.build/en/18/