CGATOxford / UMI-tools

Tools for handling Unique Molecular Identifiers in NGS data sets
MIT License
491 stars 190 forks source link

Add workflow to push releases to pypi #665

Open eachanjohnson opened 1 month ago

eachanjohnson commented 1 month ago

This GitHub workflow will push new GH releases automatically to pypi. One caveat is that the pypi API key needs to be stored in the repository or organisation secrets (under Settings) as PYPI_API_TOKEN.

Relates to issue #663

TomSmithCGAT commented 1 month ago

Thanks @eachanjohnson. I've add the pypi API key as PYPI_API_TOKEN under the repository secrets.

I assume the only way to check it's all working is to merge this PR and then issue a test release?

eachanjohnson commented 1 month ago

I did some digging. There's a test PyPI index at https://test.pypi.org/. I've added an untested workflow to upload to TestPyPI which is triggered when a tag is pushed, so you can check success before publishing the tag as a release. It requires an account on https://test.pypi.org/ and TEST_PYPI_API_TOKEN stored as a secret.

(Although tests are failing so it might need some tweaking).