wtsi-npg / samtools_container

Scripts to create a docker container for samtools
1 stars 7 forks source link

add tag instructions to README #16

Closed jmtcsngr closed 1 month ago

jmtcsngr commented 8 months ago

To prevent issues when making releases. Seems using Web UI is not compatible with our github actions for deploy.

kjsanger commented 8 months ago

You could use the web UI to do the release by creating a tag. However, I'm not sure the tags are annotated in that case (and hence won't have author and date attached).

What you shouldn't do is create a release by hand because that is done by create-release.yml and you'd end up with that automation failing. Create release exists so that we don't need to do it by hand, including building and uploading artifacts such as the Docker image.

jmtcsngr commented 8 months ago

So would it be correct to say you can either tag in Web UI or tag in CLI? I don't ever tag with Web UI so I don't know the effect.

Then say: avoid releasing with Web UI because it is not compatible with release action?

dkj commented 5 months ago

You could use the web UI to do the release by creating a tag.

I think the GitHub web UI only allows tag creation with a release - I don't see how to create a tag without a release in the web interface. If this is right I think the text is good to go...