Use setuptools-scm for versioning #748
Conversation
Codecov Report
@@ Coverage Diff @@
## master #748 +/- ##
==========================================
- Coverage 92.86% 92.83% -0.04%
==========================================
Files 35 36 +1
Lines 5533 5537 +4
Branches 941 941
==========================================
+ Hits 5138 5140 +2
- Misses 307 309 +2
Partials 88 88
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
This comment was marked as off-topic.
This comment was marked as off-topic.
- generate aiomysql/_scm_version.py at build time, fallback to `unknown` if it doesn't exist - include setuptools-scm-git-archive to support versioning in archives from git tags - install aiomysql package in readthedocs and access generated version to embed in docs Split from #734, including suggestions from @webknjaz Co-authored-by: Sviatoslav Sydorenko <wk@sydorenko.org.ua>
Nothing4You
force-pushed
the
setuptools-scm
branch
from
cf34652
to
1beebaa
Compare
This comment was marked as outdated.
This comment was marked as outdated.
…etuptools-scm to work
This comment was marked as outdated.
This comment was marked as outdated.
|
readthedocs builds don't currently have enough git context to determine the correct version, see build output for the this relates to readthedocs/readthedocs.org#5031, I've requested the related feature flag via support form. |
|
RTD now fetches the full git history, showing correct scm generated version numbers. |
This comment was marked as outdated.
This comment was marked as outdated.
|
the only issue left with this is that |
|
This pull request introduces 1 alert when merging e098883 into 42532c8 - view on LGTM.com new alerts:
|
| @@ -0,0 +1 @@ | |||
| ref-names: $Format:%D$ | |||
There was a problem hiding this comment.
@Nothing4You FYI the recent versions of setuptools-scm need a more complete template — the current one has 4 lines, not just one.
What do these changes do?
Use setuptools-scm for versioning
unknownif it doesn't existTo do
Makefileto fetch git tags to ensure consistent versioning for local builds, see Implement release workflow in GitHub actions #734 (comment)Are there changes in behavior for the user?
Self-reported
__version__now returns version generated bysetuptools-scmduring build, otherwise'unknown'.Related issue number
split from #734
Checklist
CHANGES.txt