DoubletFinder icon indicating copy to clipboard operation
DoubletFinder copied to clipboard

Tagged Github release?

Open MynorKyllJoy opened this issue 3 years ago • 2 comments

Hello,

My collegues and I are using your package in our scRNA-seq Seurat pipelines. We were wondering if you could make one tagged Github release so your package could be more compatible with other software and packages we are using in our pipeline.

Thank you for your answer.

MynorKyllJoy avatar Apr 17 '21 02:04 MynorKyllJoy

Hi @MynorKyllJoy -- could you provide more details about what a "tagged Github release" is?

chris-mcginnis-ucsf avatar Jul 19 '21 23:07 chris-mcginnis-ucsf

Hello @chris-mcginnis-ucsf ,

You can tag commits or versions of your package. This will create a copy of your current code which will not change when you make future changes. For example if you tag DoublerFinder as v1.0.0 now and update the code to a v2.0.0 or a v1.1.0 later, people using you package can easily access v1.0.0, v1.1.0 and v2.0.0. This is beneficial if someone using your package needs the v1.0.0 because there are compatibility issues between v2.0.0 and the packages/dependencies they use. It can also make your package more compatible with other non-R software which is something my collegues and I would like.

You can tag the current version of your code by using 'git tag -a v1.0.0' or 'git tag -a v1.0.0 -m "Tag Message"' and then push the tags via 'git push --tags' into your Github repository

Tags can also be changed or deleted later, i.e., after a bug fix since the changes will otherwise not affect the tagged version. It is also possible to tag older commits.

MynorKyllJoy avatar Jul 22 '21 12:07 MynorKyllJoy