feat(jobs): accept yaml configuration data #1463
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
Example files are deliberately not converted in this commit to test json parsing with js-yaml
JSON is still accepted as well, but documentation will be updated to use YAML. Move jobConfig.example.yaml to the top-level for better visibility.
sbliven
changed the title
sbliven
added a commit
to sbliven/scicat-backend-next
that referenced
this pull request
Oct 31, 2024
- Update docstring - update jobConfig.example.json. Changes will need to be converted to yaml following the merge of SciCatProject#1463
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.
Description
Implement #1120 by using a yaml parser in place of the JSON parser for the jobconfig file. Note that JSON files are also valid YAML, so this change is backwards-compatible to existing json configuration files.
Motivation
YAML is
Changes:
JOB_CONFIGURATION_FILEenv variable.Tests included
Documentation
official documentation info
Examples have been updated from json to yaml in the documentation#56