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

Comments

Projects
4 participants
@obestwalter
Member

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

This comment has been minimized.

Member

obestwalter commented Mar 10, 2017

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

@obestwalter obestwalter added this to todo in Project health Mar 10, 2017

@obestwalter

This comment has been minimized.

Member

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

This comment has been minimized.

Contributor

RonnyPfannschmidt commented Mar 12, 2017

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

obestwalter added a commit to Avira/tox that referenced this issue Mar 13, 2017

@obestwalter obestwalter moved this from todo to doing in Project health Mar 13, 2017

@obestwalter obestwalter changed the title from Use setuptools_scm for versionig to Use setuptools_scm for versioning Mar 13, 2017

@pawamoy

This comment has been minimized.

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

This comment has been minimized.

Member

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

This comment has been minimized.

Contributor

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

This comment has been minimized.

Member

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

This comment has been minimized.

Member

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.

@obestwalter obestwalter moved this from doing to done in Project health Jul 1, 2017

@obestwalter obestwalter moved this from finalize to done in [released]2.8.x Jul 2, 2017

@obestwalter obestwalter moved this from finalize to done in [released]2.8.x Jul 14, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment