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

Use setuptools_scm for versioning #474

Closed
obestwalter opened this issue Mar 10, 2017 · 8 comments
Closed

Use setuptools_scm for versioning #474

obestwalter opened this issue Mar 10, 2017 · 8 comments
Assignees

Comments

@obestwalter
Copy link
Member

@obestwalter obestwalter commented Mar 10, 2017

This tool hooks into setup.py and provides versioning from e.g. git tags. This makes frequent releases less painful as there is no manual version setting in the sources necessary anymore as this is set and read from git tags.

The default versioning does already what we need for tox versioning.

@obestwalter obestwalter self-assigned this Mar 10, 2017
@obestwalter
Copy link
Member Author

@obestwalter obestwalter commented Mar 10, 2017

@RonnyPfannschmidt not surprised about your thumbs up here ;) great little tool - thanks for that!

@obestwalter
Copy link
Member Author

@obestwalter obestwalter commented Mar 12, 2017

I wonder if we might run into this problem: rtfd/readthedocs.org » bad interaction with setuptools_scm. Just leaving this here as a reminder in case there are problems with building the docs.

Will use recommended way to start with.

@RonnyPfannschmidt
Copy link
Contributor

@RonnyPfannschmidt RonnyPfannschmidt commented Mar 12, 2017

@obestwalter it will help to just use pkg_ressoruces or the version files for then rtd usage

@obestwalter obestwalter changed the title Use setuptools_scm for versionig Use setuptools_scm for versioning Mar 13, 2017
@pawamoy
Copy link

@pawamoy pawamoy commented Mar 17, 2017

Maybe bumpversion could be of interest here.

You can define in .bumpversion.cfg the files in which to search for version tags, and then use the command line tool to update them all at the same time.

It can as well commit the changes and create a git tag automatically.

Here is a typical configuration I use:

[bumpversion]
current_version = 1.0.3
commit = True
tag = True

[bumpversion:file:setup.py]
[bumpversion:file:src/app/__init__.py]
[bumpversion:file:docs/conf.py]
@obestwalter
Copy link
Member Author

@obestwalter obestwalter commented Mar 17, 2017

@pawamoy thanks for the tip, but as setuptools_scm is the pypa blessed package to do that and our @RonnyPfannschmidt is the core dev I rather go with that :)

@RonnyPfannschmidt
Copy link
Contributor

@RonnyPfannschmidt RonnyPfannschmidt commented Mar 17, 2017

one of the reasons i created setuptools_scm and pushed it into pypa is this mess of editing and committing dozens and dozens of files of actual data just to create metadata - when one can just use metadata

@nicoddemus
Copy link
Member

@nicoddemus nicoddemus commented Mar 17, 2017

Just a note of warning about bumpversion that I just realized yesterday while creating a conda recipe for it: it seems to be largely unmaintained at moment, with lots of PRs sitting there without answer and the last commit to master being from 2015.

@obestwalter
Copy link
Member Author

@obestwalter obestwalter commented Mar 17, 2017

PRs sitting there without answer and the last commit to master being from 2015.

oh well, another case of maintainer burnout - or just loss of interest.

@tox-dev tox-dev locked and limited conversation to collaborators Jan 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

4 participants