Hi. Question about template upgrade while everyone...
# tools
m
Hi. Question about template upgrade while everyone is online. When upgrading a pipeline from an old template, what strategy do people use / recommend ? 1. full upgrade (
sync
+
git merge
) one version at a time 2.
sync
one version at a time, and then a big
git merge
3. a single
sync
directly onto the latest version, and
git merge
(or any other strategy I didn’t think of ?). I’ve only tried number 1 by fear of large merge conflicts, but I really don’t know if that’s better.
🤔 1
f
I would say it depends on the state of your pipeline. But I ususally go for number 3 because it feels like too much work otherwise?
I do only have a small pipeline though so it was never a really big amount of work
j
I would also go with option 3, but it's true that it can get really big if the pipeline is very outdated
f
So maybe if you swap from a low 2 to 3 it might make sense to have an in between step?
j
also in case it's useful, since version 2.14.0 there is a version in the tools release blog posts to help with resolving merge conflicts https://nf-co.re/blog/2024/tools-2_14#how-to-merge-the-pipeline-template-updates
and for some of them we also have bytesize talks
m
I’ve got a few pipelines from the 2.5 era to migrate …
panic mild 1
j
how was your experience with strategy 1?
m
Long …
🙊 1
The benefit is that it made me see and learn what each nf-core version brought in. I feel like I could better understand what changed and why, and solved the merge conflicts
On the other hand, I spent some time fully implementing nf-validation and then moving to nf-schema. That was totally not needed
😱 1
😞 1
j
yes I fear this would be the case for such outdated pipelines, that's why I would advice to do everything at once
but then it becomes a huge change and the information will be split in different places
a
For large jumps (ie subworkflow restructuring) I used a process where I made the update and merge in a temporary copy of the pipeline, then I would create a separate branch where I made "pre-changes" based on the sync/merge for large structural elements in preparation of doing the sync again. This helped to create cleaner PRs where functional and structural changes were more easily demarcated.
👍 1