Adding Github action to automatically publish to pypi #271
Conversation
This file contains hidden or 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
Publishing id3c to pypi will help standardize how this package is being installed compared to other dependencies. This will make the package simpler include in multiple applications and pin to a specific version when needed. One workflow change this will require is that commits on master branch will need to be tagged to be published to pypi.org (whereas all commits on master branch will be published to test.pypi.org). A version naming convention will need to be decided on and integrated into the deployment workflow, but the specific format chosen will not impact this PR.
Contributor
Author
|
A simple version naming convention was already established, so one option is to stick with that: |
Publishing to test.pypi.org on each push to master creates a couple of challenges. First pypi cannot overwrite a file with the same name, which is the case when publishing a package that does not have a different reference tag in github. There are some solutions to work around this by having a specific "RC" tag format for release candidates and only publishing those to test.pypi.org. At this point that would create additional unnecessary steps in the deployment process but may be worth revisiting in the future once there is a versioning/tagging conventions are established.
davereinhart
force-pushed
the
github-action-publish-to-pypi
branch
from
bec57d3 to
75a77de
Compare
kschwabefry
approved these changes
Jan 14, 2022
Contributor
Author
|
Note to self: this needs to be rebased and updated to use Python 3.9 |
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.
Publishing id3c to pypi will help standardize how this package is being
installed compared to other dependencies. This will make the package simpler
include in multiple applications and pin to a specific version when needed.
One workflow change this will require is that commits on master branch will need to
be tagged to be published to pypi.org (whereas all commits on master branch will be
published to test.pypi.org). A version naming convention will need to be
decided on and integrated into the deployment workflow, but the specific format
chosen will not impact this PR.