search

jodyphelan / tbdb

Standard database for the TBProfiler tool
GNU Lesser General Public License v3.0
28 stars 18 forks source link

Releases/Versions #44

Closed jwarnn closed 2 years ago

jwarnn commented 2 years ago

I think it would be useful to do releases for this repository. If this tool is used in research it would be best to be able to report a version or release data for reproducibility. TBProfiler is a great tool!

jodyphelan commented 2 years ago

Thanks for using the tool! At the moment the version is given using the git commit string. For example the db currently packaged with TB-Profiler has the following version:

{"commit": "4738132"}

I just checked out the conversation at https://github.com/StaPH-B/docker-builds/issues/416. Would there be an advantage to using a release over the current system?

jwarnn commented 2 years ago

The current system will work. For StaPH-B/docker-builds we just like to keep the tools up to date but also track versions of the software that we use for purposes of reporting and maintaining reproducibility. So for the tools that I have contributed to I will usually look biweekly to see if there are any updates to those tools. So it is just a matter of ease. I would look for a new commit in tpdb or a release of TBProfiler then make a new docker image. That way those who use a tool in their workflow can choose whether they need to update it or continue to use the older versions. So since its a marginal benefit and if it would be to much of a headache for you; the current system is great. Thank you.

FYI we usually run our docker-builds using workflow tools like Nextflow, WDL, and CWL. Then those workflows run on the cloud, in local linux clusters, or on personal computers.

jodyphelan commented 2 years ago

Thanks @jwarnn, If for some reason you prefer the releases in the future let me know! I can always set up a webhook or something to notify of a new commit.