Add a github action workflow to upload to PyPI #57
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #57 +/- ##
=======================================
Coverage 40.79% 40.79%
=======================================
Files 2 2
Lines 527 527
=======================================
Hits 215 215
Misses 312 312 Continue to review full report at Codecov.
|
Previously, we would manually run `util/release.bash` to tag a new release and upload it to PyPI. This required having local PyPI credentials and being careful that your branches were all up to date. This adds a github action to simplify and automate release creation. When a new release is created (or if manually started) the job will run testing and if that passes will then create the release and upload it. We run the test and build/upload steps in separate jobs to ensure we have a clean environment for the upload. And note that testing manually installs the package and runs pytest instead of using tox, just to make sure that things work from a user perspective and there's no dependencies that are listed in tox, but not setup.py. By default this will upload to the official pypi repo and authentication is done with a secret token. To test releases, there is also an option to upload to test.pypi.
lydia-duncan
approved these changes
Mar 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we would manually run
util/release.bashto tag a newrelease and upload it to PyPI. This required having local PyPI
credentials and being careful that your branches were all up to date.
This adds a github action to simplify and automate release creation.
When a new release is created (or if manually started) the job will run
testing and if that passes will then create the release and upload it.
We run the test and build/upload steps in separate jobs to ensure we
have a clean environment for the upload. And note that testing manually
installs the package and runs pytest instead of using tox, just to make
sure that things work from a user perspective and there's no
dependencies that are listed in tox, but not setup.py.
By default this will upload to the official pypi repo and authentication
is done with a secret token. To test releases, there is also an option
to upload to test.pypi.