Dump template yml to file in pipeline repo after creation #2189
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
Codecov Report
@@ Coverage Diff @@
## dev #2189 +/- ##
==========================================
+ Coverage 71.53% 71.92% +0.38%
==========================================
Files 77 77
Lines 8369 8373 +4
==========================================
+ Hits 5987 6022 +35
+ Misses 2382 2351 -31
... and 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
mashehu
approved these changes
Feb 22, 2023
| log.debug("Dumping pipeline template yml to file") | ||
| if self.template_yaml: | ||
| with open(self.outdir / "pipeline_template.yml", "w") as fh: | ||
| yaml.safe_dump(self.template_yaml, fh) |
There was a problem hiding this comment.
Suggested change
| yaml.safe_dump(self.template_yaml, fh) | |
| yaml.safe_dump(self.template_yaml, fh) | |
| run_prettier_on_file(fh.name) |
There was a problem hiding this comment.
So this should only trigger when a template_yml is either supplied (which perhaps is silly) or someone customises something on the CLI.
Currently there are no tests which mock passing information in via the CLI prompts that I'm aware of. Happy to try adding them but not sure if it's best done as a unit-test or as part of one of the fuller tests defined in the GH actions?
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.
Adds feature to solve #2143
The template yaml is now required to properly lint/sync custom pipelines. Currently if it's initially retrieved from CLI inputs when running
nf-core createit does not get saved to file anywhere.This PR dumps the template yaml used to create the pipeline into a
pipeline_template.ymlfile in the new repo.PR checklist
CHANGELOG.mdis updateddocsis updated