Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub action that releases to PyPI on Create Release #133

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

IbraheemTuffaha
Copy link

As explained in #126, you cannot release a package to PyPI with a direct dependency like whisper-jax (i.e. only installed using pip install git+https://github.com/sanchit-gandhi/whisper-jax.git).

To fix this, the package must be released to PyPI.
I added a GitHub Action to easily allow this to happen.
You only need to make sure you update the version here with every release:

__version__ = "0.0.1"

Then create a tag for every important change then create a release from the tag.
I suggest using Semantic Versioning 2.0.0 for choosing the next release version increment.

To test the release, I tried it on TestPyPI and it worked releasing v0.0.1 (I'll delete it or handover ownership to you if you want).

Now for the real PyPI, you must create a new project from Publishing, at the bottom you will find this 👇

image
Fill it with:

whisper-jax
sanchit-gandhi
whisper-jax
release.yml

And then we're good to go. It'll be ready to do the release from GitHub :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant