pass ScmVersion to dump_version to provide scm_version as extra template variable
#854
Conversation
Signed-off-by: Zhiyuan Chen <chenzhiyuan@dp.tech>
Signed-off-by: Zhiyuan Chen <chenzhiyuan@dp.tech>
for more information, see https://pre-commit.ci
src/setuptools_scm/__init__.py
Outdated
| parsed_version, | ||
| version_scheme=config.version_scheme, | ||
| local_scheme=config.local_scheme, | ||
| ) | ||
| if config.write_to is not None: | ||
| dump_version( | ||
| root=config.root, | ||
| version=version_string, | ||
| version=parsed_version, |
There was a problem hiding this comment.
i recommend using the name scm_version or parsed_version as input names so it can be distinguished
There was a problem hiding this comment.
thanks for preparing this
unfortunately the argument rename is a breaking change that will get downstreams by surprise
as such the old name needs to stay and the new object needs to go in by a different name
there may be need for extra considerations wrt what attributes to put on ScmVersion to help formatting
RonnyPfannschmidt
changed the title
Version to dump_versionScmVersion to dump_version to provide scm_version as extra template variable
There was a problem hiding this comment.
this looks much better now, thanks!
for completeness i would recommend to add a unit-test that uses a custom template to dump the node in addition to the normal version and checks for it
with the addition of a changelog note on the feature addition this would be ready to merge then
i presume the pdb calls will go away then
👍
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
testing/test_basic_api.py
Outdated
| dump_version(tmp_path, "1.0.1+g4ac9d2c", "second.py") | ||
| version = "1.0.1+g4ac9d2c" | ||
| scm_version = meta("1.0.1", node="g4ac9d2c", config=c) | ||
| dump_version(tmp_path, version, scm_version, "second.py") |
There was a problem hiding this comment.
Unfortunately this doesn't Test The new feature
Signed-off-by: Zhiyuan Chen <chenzhiyuan@dp.tech>
Signed-off-by: Zhiyuan Chen <chenzhiyuan@dp.tech>
for more information, see https://pre-commit.ci
Thanks~ I believe it's better to squash the changes, as most commits are redundant" |
|
Thanks for enabling this |
fixes #853
related to #818
related to #577