setuptools_scm icon indicating copy to clipboard operation
setuptools_scm copied to clipboard

Published 20 hours ago • verified publisher icon pypa

Missing documentation for calver

Open kasium opened this issue 3 years ago • 18 comments
trafficstars

I found out that this project supports calver (e.g. calver-by-date) but these options are not documented

kasium avatar Jun 22 '22 12:06 kasium

Hi buddies, any quick start for how to use it?

huxuan avatar Jul 28 '23 05:07 huxuan

Starting point is to use one of the Calver named Version shemes as per the readme

The documentation rework in #880 will eventually provide better examples

RonnyPfannschmidt avatar Jul 28 '23 09:07 RonnyPfannschmidt

I tried to change the version_scheme to calver-by-date, but seems it will still use the git tag when the repo is clean. So maybe the problem is what is the best practice to use calver. It might also including how to manage git tags or even the migration from normal semver to calver.

huxuan avatar Jul 28 '23 10:07 huxuan

Current behavior is that on exact tags The Tag wins

RonnyPfannschmidt avatar Jul 28 '23 10:07 RonnyPfannschmidt

I'm either blind or the docs are still missing for this?

Basically I wonder if/how can I achieve this:

vYYYY.MM.<sequence>[.devX]

jziolkowski avatar Sep 21 '24 19:09 jziolkowski

@jziolkowski this would be something called "calver-by-month" its currently not implemented

https://github.com/pypa/setuptools-scm/blob/d665621e25f091c0de5cd35b3d57cc00bd26e260/src/setuptools_scm/version.py#L323-L413 implements it for `vYYYY.MM.DD.{sequence}[.devX]

im open to adoption it to support calver-by-month but i cant implement it myself soon

RonnyPfannschmidt avatar Sep 25 '24 14:09 RonnyPfannschmidt