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

make TAGS for releases to pypi #12

Closed
adriaanph opened this issue Jun 14, 2021 · 5 comments
Closed

make TAGS for releases to pypi #12

adriaanph opened this issue Jun 14, 2021 · 5 comments

Comments

@adriaanph
Copy link
Contributor

please create a TAG with the version number whenever you push a new release to pypi.org

@jacopoantonello
Copy link
Owner

Currently a new release is automatically created and pushed to pypi every time commits are added to master. The version number is also automatically incremented. So I wasn't planning to create tags here. This saves me time as I don't have to do anything besides committing to master (GitHub uploads to pypi itself). Does this create issues on your side?

@adriaanph
Copy link
Contributor Author

no, it doesn't create any issues as such, it's just for traceability. for example, when i encoutered the "version=0.0.0" issue #11 i wanted to browse the github repository at the revision that corresponds with the package in pypi. however, because i couldn't find any TAGS i had to go on a hunt.

@adriaanph
Copy link
Contributor Author

i have just seen that you do in fact create tags, but they are "informal TAGS" rather than "annotated TAGS". i suspect that simply using "annotated TAGS" should resolve both issues #11 & #12.

informal TAGS are listed by git describe, currently:
v0.0-30-g39e5902

annotated TAGS are listed by git tag, currently:
v0.0

according to the git reference

Annotated tags are meant for release while lightweight tags are meant for private or temporary object labels.

@jacopoantonello
Copy link
Owner

I only created one annotated tag v0.0. I did use the informal tags in the past but they are not compatible with PyPI as far as I could tell, so I disabled them. I plan only to add another annotated tag if something major changes in the future.

setup.py automatically generates a version from the v0.0 tag every time new commits are added to master. And it automatically publishes the package to PyPI. So I don't have to do that manually. You can still have some traceability

import zernike
print(zernike.__commit__)

This is not best practice. But for now I'd rather keep this simple system unless there are major inconveniences with it.

@adriaanph
Copy link
Contributor Author

i have no reason to keep pushing this point, this is your prerogative.

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

No branches or pull requests

2 participants