stjudecloud / workflows

Bioinformatics workflows developed for and used on the St. Jude Cloud project.
MIT License
34 stars 10 forks source link

Split tasks to a new repository #130

Open adthrasher opened 9 months ago

adthrasher commented 9 months ago

Finally, we plan to migrate the WDL tools to a new repository. There are several tasks required before we can make the change.

a-frantz commented 9 months ago

Choose versioning scheme

My proposal, as loosely inspired by how I've seen many Rust crates organized (like noodles):

How a user interacts with this: If they are only using a single tool, they could import that specific file, with that \-\ tag. This is kind of a "mouthful" of a version. I view this as being for advanced users. If they are using a whole bunch of different tools/files, they would specify a "repo version" which would obfuscate the file-level versions.

How we interact with this: Since we won't be pinging users for every tool revision, we can feel free to update these as often and as trivially as we want. We only ping users when we've made enough changes that we want to notify them. And then we make a repo-wide release.

If a user wants to be on the bleeding edge, they can import everything at the latest file/tool level. However we would recommend most users to use the "convenience" version that packages everything together as a v1.x.x.