MAINT: Use setuptools_scm to manage versioning #83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Best reviewed: commit by commit
Optimal code review plan
|
oesteban
force-pushed
the
maint/versioneer
branch
5 times, most recently
from
c90871e
to
50c830c
Compare
Codecov Report
@@ Coverage Diff @@
## master #83 +/- ##
=========================================
- Coverage 98.95% 98.2% -0.75%
=========================================
Files 12 12
Lines 1050 1059 +9
Branches 135 135
=========================================
+ Hits 1039 1040 +1
- Misses 6 14 +8
Partials 5 5
Continue to review full report at Codecov.
|
oesteban
force-pushed
the
maint/versioneer
branch
3 times, most recently
from
35b5e1a
to
da123ab
Compare
Summary ------- Pilots whether we can abandon versioneer in all projects, as setuptools_scm has minimal boilerplate. Changes ------- The setuptools_scm module is added to the pyproject.toml file, as recommended in the documentation. A tiny hack is added to the root ``__init__.py`` file, so that the version is read from ``nitransforms/_version.py`` when that file exists or it is interpolated via ``setuptools_scm.get_version``. To make the version traverse into container images, before building, ``python setup.py --version`` must be invoked first (and it will create the ``nitransforms/_version.py`` file. ``nitransforms/_version.py`` has been added to ``.gitignore`` to avoid adding it by mistake. Finally, the CircleCI workflow is also modified, so that the packaging is always tested and installed versions are checked both for python packages and docker distributions. Resolves: nipy#82
oesteban
force-pushed
the
maint/versioneer
branch
from
da123ab
to
2670b12
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Pilots whether we can abandon versioneer in all projects, as
setuptools_scm has minimal boilerplate.
Changes
The setuptools_scm module is added to the pyproject.toml file,
as recommended in the documentation.
A tiny hack is added to the root
__init__.pyfile, so thatthe version is read from
nitransforms/_version.pywhen thatfile exists or it is interpolated via
setuptools_scm.get_version.To make the version traverse into container images, before building,
python setup.py --versionmust be invoked first (and it will createthe
nitransforms/_version.pyfile.nitransforms/_version.pyhas been added to.gitignoreto avoidadding it by mistake.
Finally, the CircleCI workflow is also modified, so that the packaging
is always tested and installed versions are checked both for python
packages and docker distributions.
Resolves: #82