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

build/use-setuptools-scm-for-versioning #52

Merged
merged 15 commits into from
Aug 2, 2022

Conversation

tlambert03
Copy link
Contributor

@tlambert03 tlambert03 commented Jul 24, 2022

Pull request recommendations:

  • Name your pull request your-development-type/short-description. Ex: feature/read-tiff-files
  • Link to any relevant issue in the PR description. Ex: Resolves [admin/build-py39 #12], adds tiff file format support
  • Provide context of changes: use pyproject.toml ... modernize build #51
  • Provide relevant tests for your feature or bug fix.
  • Provide or update documentation for any feature added by your pull request.

Thanks for contributing!

@tlambert03 tlambert03 changed the title use setuptools-scm for versioning build/use-setuptools-scm-for-versioning Jul 24, 2022
__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:
Copy link
Contributor Author

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?

Copy link
Collaborator

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-commenter
Copy link

codecov-commenter commented Jul 24, 2022

Codecov Report

Merging #52 (a16e500) into main (cba1f91) will not change coverage.
The diff coverage is n/a.

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cba1f91...a16e500. Read the comment docs.

@evamaxfield
Copy link
Collaborator

Sorry about the conflict now. Will review this tomorrow tho!

@tlambert03
Copy link
Contributor Author

no worries! thanks for the new release! manifest definitely made it in this time.

Copy link
Collaborator

@evamaxfield evamaxfield left a 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!

Comment on lines +67 to +80
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)
Copy link
Collaborator

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:
Copy link
Collaborator

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
Copy link
Collaborator

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?

@evamaxfield evamaxfield merged commit a7aad09 into AllenCellModeling:main Aug 2, 2022
@tlambert03 tlambert03 deleted the setuptools-scm branch August 3, 2022 11:52
@tlambert03
Copy link
Contributor Author

sorry for delayed response here. thanks for the merge :) I believe git tag there will show all tags, just for ci debugging purposes

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.

3 participants