docs(user-guide): document workflow template placeholder variables - #421
Open
bohdanmaliar wants to merge 1 commit into
Open
bohdanmaliar wants to merge 1 commit into
bohdanmaliar wants to merge 1 commit into
Conversation
Explain the ${input:variable_name} placeholder syntax and the Configure
Template Variables dialog shown when creating a workflow from a template
that uses placeholders, and distinguish it from the existing runtime
{{variable_name}} syntax. Adds two related FAQ entries.
EPMCDME-10585
This branch has not been deployed
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
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.
Summary
Documents the new placeholder-variable feature for workflow templates (EPMCDME-10585): authors can mark values in a template's YAML with
${input:variable_name}, and users are prompted once per unique placeholder via a Configure Template Variables dialog when creating a workflow from that template.Changes
create-workflow-from-template.mdwith a new step describing the Configure Template Variables dialog (including a screenshot) and a "Using Placeholder Variables in Templates" section explaining the${input:variable_name}syntax with a real exampleconfiguration/introduction.mddistinguishing the creation-time${input:...}syntax from the existing execution-time{{variable_name}}syntax${input:...}and{{variable_name}}Testing
npm startQuality Checks
npm run checkpasses (typecheck + lint + commitlint)<text>must be`<text>`)static/img/)Additional Notes
Screenshot added:
docs/user-guide/workflows/images/configure-template-variables-dialog.png