[feat] Enable YAML configuration files #3370
Open
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
vkarak
force-pushed
the
feat/yaml-config
branch
3 times, most recently
from
c154779 to
72fe599
Compare
vkarak
force-pushed
the
feat/yaml-config
branch
from
72fe599 to
2868c42
Compare
teojgo
requested changes
Jan 31, 2025
| ===================== | ||
|
|
||
| One advantage of ReFrame's configuration is that it is programmable, especially if you are using the Python files. | ||
| Since the configuration is loaded a Python module, you can generate parts of the configuration dynamically. |
There was a problem hiding this comment.
Suggested change
| Since the configuration is loaded a Python module, you can generate parts of the configuration dynamically. | |
| Since the configuration is loaded as a Python module, you can generate parts of the configuration dynamically. |
| Since the configuration is loaded a Python module, you can generate parts of the configuration dynamically. | ||
|
|
||
| The YAML configuration on the other hand is more static, although not fully. | ||
| Code generation can still be used with the YAML configuration as it is treated as Jinja2 template, where ReFrame provides the following bindings: |
There was a problem hiding this comment.
Suggested change
| Code generation can still be used with the YAML configuration as it is treated as Jinja2 template, where ReFrame provides the following bindings: | |
| Code generation can still be used with the YAML configuration as it is treated as a Jinja2 template, where ReFrame provides the following bindings: |
| - ``sh(<command>)``: Retrieve the standard output of a shell command. | ||
| The command must be successful. | ||
|
|
||
| These are two examples YAML logging configuration that uses one of those bindings: |
There was a problem hiding this comment.
Suggested change
| These are two examples YAML logging configuration that uses one of those bindings: | |
| These are two examples of YAML logging configuration that uses one of those bindings: |
|
|
||
| Apart from Python, ReFrame's configuration can be specified in a YAML file. | ||
| The advantage is a more compact configuration, but it's not fully programmable as is the Python configuration. | ||
| Below is the same configuration file presetend above, but in YAML: |
There was a problem hiding this comment.
Suggested change
| Below is the same configuration file presetend above, but in YAML: | |
| Below is the same configuration file presented above, but in YAML: |
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.
This PR introduces YAML configuration files and deprecates raw JSON configuration files.
Check the updated docs for more details:
Closes #3322.
Todos