Skip to content

Consider using both bump2version and setuptool_scm #5

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

Closed
adamltyson opened this issue Nov 10, 2022 · 4 comments
Closed

Consider using both bump2version and setuptool_scm #5

adamltyson opened this issue Nov 10, 2022 · 4 comments

Comments

@adamltyson
Copy link
Member

adamltyson commented Nov 10, 2022

An excellent idea from @dstansby:

maybe a good way to go would be to use both, and use bump2version to just set the git tag correctly, with setuptools_scm handling setting the Python package version from the git tag?

We should test this. In theory this should allow for the nice bits of bump2version such as being able to set the version semantically rather than numerically, but without the complex setup to define what gets updated and where.

This should also hopefully future proof us a bit to changes in python packaging.

cc @SainsburyWellcomeCentre/neuroinformatics-unit

@niksirbi
Copy link
Member

That sounds like a great idea if it actually works in practice, without the two tools clashing

@JoeZiminski
Copy link
Member

Interesting discussion on this here, in the end I believe they have also taken this joint approach.

@adamltyson
Copy link
Member Author

Now gone with only setuptools_scm. Need to document this (and remove the bump2version docs).

@adamltyson
Copy link
Member Author

setuptools_scm is now documented

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

3 participants