-
Notifications
You must be signed in to change notification settings - Fork 29
feat: uniform handlebar variables for job actions #1855
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
The change is most visible in handlebars templates. Before, `{{this}}` would correspond to different objects depending on how the action is called; either a DTO or a Job or even a Dataset. Now these are accessed consistently through top-level fields; thus `{{id}}` becomes `{{job.id}}`, `{{jobParams}}` becomes `{{request.jobParams}}`, etc. This also adds access to environmental variables via `{{env}}`, making it easier to include secrets actions without hard-coding them. Tests and example files should be up-to-date.
Datasets get cached in the context, meaning that they only need to be fetched once for all actions.
sbliven
added a commit
to sbliven/scicat-documentation
that referenced
this pull request
Apr 24, 2025
sbliven
added a commit
to sbliven/scicat-documentation
that referenced
this pull request
Apr 24, 2025
despadam
approved these changes
May 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this a lot 👍
4 tasks
sbliven
added a commit
to sbliven/scicat-documentation
that referenced
this pull request
May 14, 2025
sbliven
added a commit
to SciCatProject/documentation
that referenced
this pull request
May 14, 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.
Description
Many job actions accept handlebars templates. This exposes additional variables to the templates and makes accessing variables consistent across all the different scopes that actions are executed in.
All templates now receive the following context:
Before,
{{this}}
would correspond to different objects depending on how the action iscalled; either a DTO or a Job or even a Dataset. Now these are accessed
consistently through top-level fields; thus
{{id}}
becomes{{job.id}}
,{{jobParams}}
becomes{{request.jobParams}}
, etc.This also adds access to environmental variables via
{{env}}
, makingit easier to include secrets actions without hard-coding them.
Tests and example files should be up-to-date.
Motivation
Adding env makes it easier to reference secrets securely without putting them in jobConfig.yaml.
Having a shared context among all jobs is also convenient for caching (eg of the datasets)
Fixes
Changes:
Tests included
Documentation
official documentation info
SciCatProject/documentation#70