Make output of planemo workflow_job_init more helpful#1595
Merged
jmchilton merged 7 commits intogalaxyproject:masterfrom Jan 5, 2026
Merged
Make output of planemo workflow_job_init more helpful#1595jmchilton merged 7 commits intogalaxyproject:masterfrom
jmchilton merged 7 commits intogalaxyproject:masterfrom
Conversation
The workflow_job_init command now includes YAML comments with the input parameter type and doc (description) above each input entry in the generated job file. This helps users understand the expected input types when filling out job templates.
- Replace manual comment generation with ruamel.yaml for proper YAML comment support in workflow job templates - Add ruamel.yaml as a dependency - Include optionality information in parameter metadata comments (shows "optional: true" for optional parameters or those with defaults)
- Include all workflow inputs (not just required ones) in the generated job template - Add default values to metadata and display them in YAML comments - Use default values as template values for parameters that have them - Show "optional: true" for optional parameters or those with defaults
When workflow inputs have a format restriction (e.g., fastq, tabular), this is now displayed in the YAML comment for that input parameter.
- Add test workflow with various parameter types (optional, defaults, format) - Test integer and boolean parameter handling - Test that optional parameters show "optional: true" in comments - Test that default values are displayed in comments and used as values - Test that format restrictions are shown in comments - All tests use real workflow files with no mocking
Boolean parameters without a specified default now use `false` as the template value instead of the placeholder string "todo_param_value".
- Add collection_type to job template metadata and comments - Generate appropriate sample elements based on collection_type: - list: single element with identifier - paired: forward and reverse elements - list:paired: nested paired collection structure - Add comprehensive test for collection type handling
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.
Before:
After: