-
Notifications
You must be signed in to change notification settings - Fork 10
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
build/use-setuptools-scm-for-versioning #52
build/use-setuptools-scm-for-versioning #52
Conversation
__author__ = "Eva Maxfield Brown" | ||
__email__ = "[email protected]" | ||
# Do not edit this string manually, always use bumpversion | ||
# Details in CONTRIBUTING.md | ||
__version__ = "0.7.0" | ||
|
||
|
||
def get_module_version() -> str: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you use this elsewhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not. Happy to remove
Codecov Report
@@ Coverage Diff @@
## main #52 +/- ##
=======================================
Coverage 88.88% 88.88%
=======================================
Files 3 3
Lines 189 189
=======================================
Hits 168 168
Misses 21 21 Continue to review full report at Codecov.
|
Sorry about the conflict now. Will review this tomorrow tho! |
no worries! thanks for the new release! manifest definitely made it in this time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Thanks!!
A couple of questions and if you want to remove the get_module_version
feel free!
Make sure the main branch is checked out and all desired changes | ||
are merged. Then run: | ||
|
||
```bash | ||
$ bumpversion patch # possible: major / minor / patch | ||
$ git push | ||
$ git push --tags | ||
$ git tag -a "vX.Y.Z" -m "vX.Y.Z" | ||
$ git push upstream --follow-tags | ||
``` | ||
|
||
This will release a new package version on Git + GitHub and publish to PyPI. | ||
(The `-a` flag indicates an [annotated tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)) | ||
|
||
The presence of a tag starting with "v" will trigger the `publish` step in the | ||
main github workflow, which will build the package and upload it to PyPI. The | ||
version will be injected into the package metadata by | ||
[`setuptools-scm`](https://github.com/pypa/setuptools_scm) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😍
I may add a just
command for this later
__author__ = "Eva Maxfield Brown" | ||
__email__ = "[email protected]" | ||
# Do not edit this string manually, always use bumpversion | ||
# Details in CONTRIBUTING.md | ||
__version__ = "0.7.0" | ||
|
||
|
||
def get_module_version() -> str: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not. Happy to remove
@@ -90,6 +92,7 @@ jobs: | |||
python-version: 3.9 | |||
- name: Install Dependencies | |||
run: | | |||
git tag |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: will this just show the single tag that is being deployed or the whole taglist?
sorry for delayed response here. thanks for the merge :) I believe |
Pull request recommendations:
Thanks for contributing!