use "git describe" for package versioning

Author: d-biehl

.github/workflows/build-test-package-publish.yml

@@ -179,8 +179,11 @@ jobs:
       - name: install node modules
         run: npm install --also=dev
 
+      - name: update versions from git
+        run: poetry run python .\scripts\update_git_versions.py
+
       - name: update doc links
-        if: startsWith( github.ref, 'refs/tags/v')
+        if: ${{ !startsWith( github.ref, 'refs/tags/v') }}
         run: poetry run npm run update-doc-links
 
       - name: package

scripts/tools.py

@@ -1,30 +1,26 @@
 import os
 from pathlib import Path
+from typing import NamedTuple, Optional
 
 from git.repo import Repo
 from semantic_version import Version
 
 
-def get_current_version_from_git() -> Version:
-    repo = Repo(Path.cwd())
-
-    result = None
-    for tag in repo.tags:
-        v = tag.name
-        if v.startswith("v."):
-            v = v[2:]
-        elif v.startswith("v"):
-            v = v[1:]
+class GitDescribeVersion(NamedTuple):
+    version: str
+    commits: Optional[str] = None
+    hash: Optional[str] = None
 
-        try:
-            v = Version(v)
-        except ValueError:
-            continue
 
-        if not result or v > result:
-            result = v
+def get_current_version_from_git() -> Version:
+    repo = Repo(Path.cwd())
 
-    return result
+    git_version = GitDescribeVersion(*repo.git.describe("--long", "--first-parent", "--match", "v[0-9]*").split("-"))
+    version = Version(git_version.version[1:])
+    if git_version.commits is not None:
+        version = version.next_patch()
+        version.prerelease = ("dev", git_version.commits)
+    return version
 
 
 def get_version() -> Version:

scripts/update_doc_links.py

@@ -17,14 +17,14 @@ def replace_in_file(filename: Path, pattern: "re.Pattern[str]", to: str) -> None
 def main() -> None:
 
     version = get_version()
-
-    tag_base = f"{REPOSITORY_BASE}/v{version}"
-
-    replace_in_file(
-        Path("README.md"),
-        re.compile(r"(\!\[.*?\]\()(\.)(/[^\)]*?)(\))"),
-        rf"""\g<1>{tag_base}\g<3>\g<4>""",
-    )
+    if version.prerelease:
+        tag_base = f"{REPOSITORY_BASE}/v{version}"
+
+        replace_in_file(
+            Path("README.md"),
+            re.compile(r"(\!\[.*?\]\()(\.)(/[^\)]*?)(\))"),
+            rf"""\g<1>{tag_base}\g<3>\g<4>""",
+        )
 
 
 if __name__ == "__main__":

scripts/update_git_versions.py

@@ -0,0 +1,35 @@
+import re
+from pathlib import Path
+
+from scripts.tools import get_version
+
+
+def replace_in_file(filename: Path, pattern: "re.Pattern[str]", to: str) -> None:
+    text = filename.read_text()
+    new = pattern.sub(to, text)
+    filename.write_text(new)
+
+
+def main() -> None:
+
+    version = get_version()
+
+    preview = version.minor % 2 != 0
+
+    for f in ["robotcode/_version.py", "pyproject.toml"]:
+        replace_in_file(
+            Path(f),
+            re.compile(r"""(^_*version_*\s*=\s*['"])([^'"]*)(['"])""", re.MULTILINE),
+            rf"\g<1>{version or ''}{'.dev.0' if preview and version.prerelease is None else ''}\g<3>",
+        )
+
+    for f in ["package.json"]:
+        replace_in_file(
+            Path(f),
+            re.compile(r"""(\"version\"\s*:\s*['"])([0-9]+\.[0-9]+\.[0-9]+.*)(['"])""", re.MULTILINE),
+            rf"\g<1>{version or ''}{'.dev.0' if preview and version.prerelease is None else ''}\g<3>",
+        )
+
+
+if __name__ == "__main__":
+    main()

scripts/update_versions.py

@@ -21,7 +21,7 @@ def main() -> None:
         replace_in_file(
             Path(f),
             re.compile(r"""(^_*version_*\s*=\s*['"])([^'"]*)(['"])""", re.MULTILINE),
-            rf"\g<1>{version or ''}{'.dev0' if preview else ''}\g<3>",
+            rf"\g<1>{version or ''}{'.dev.0' if preview and version.prerelease is None else ''}\g<3>",
         )
 
     for f in ["CHANGELOG.md"]: