feat: add partial dynamic versioning support (not yet backwards compat)

Author: onerandomusername

.gitattributes

@@ -1,3 +1,3 @@
 # force LF for pyproject to make hashFiles in CI consistent (windows <3)
 # (see https://github.com/actions/runner/issues/498)
-pyproject.toml text eol=lf
+pyproject.toml text eol=lf export-subst

.github/workflows/lint-test.yml

@@ -59,6 +59,8 @@ jobs:
     needs: lock-dependencies
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
 
       - name: Set up environment
         uses: ./.github/actions/setup-env
@@ -126,6 +128,9 @@ jobs:
     needs: lock-dependencies
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
+
 
       - name: Set up environment
         id: setup

.github/workflows/release.yaml

@@ -18,6 +18,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
+
 
       - name: Set up environment
         id: setup

.gitignore

@@ -34,3 +34,4 @@ __pypackages__/
 .pdm.toml
 .pdm-python
 pdm.lock
+disnake/_version.py

disnake/__init__.py

@@ -14,14 +14,17 @@
 __author__ = "Rapptz, EQUENOS"
 __license__ = "MIT"
 __copyright__ = "Copyright 2015-present Rapptz, 2021-present EQUENOS"
-__version__ = "2.11.0a"
 
 __path__ = __import__("pkgutil").extend_path(__path__, __name__)
 
 import logging
-from typing import Literal, NamedTuple
 
 from . import abc as abc, opus as opus, ui as ui, utils as utils  # explicitly re-export modules
+from ._version import (
+    VersionInfo,  # pyright: ignore[reportUnusedImport] # noqa: F401
+    __version__,  # noqa: F401
+    version_info,  # pyright: ignore[reportUnusedImport] # noqa: F401
+)
 from .activity import *
 from .app_commands import *
 from .appinfo import *
@@ -77,17 +80,4 @@
 from .welcome_screen import *
 from .widget import *
 
-
-class VersionInfo(NamedTuple):
-    major: int
-    minor: int
-    micro: int
-    releaselevel: Literal["alpha", "beta", "candidate", "final"]
-    serial: int
-
-
-# fmt: off
-version_info: VersionInfo = VersionInfo(major=2, minor=11, micro=0, releaselevel="alpha", serial=0)
-# fmt: on
-
 logging.getLogger(__name__).addHandler(logging.NullHandler())

disnake/_version.pyi

@@ -0,0 +1,14 @@
+# SPDX-License-Identifier: MIT
+
+from typing import Literal, NamedTuple
+
+__version__: str
+
+class VersionInfo(NamedTuple):
+    major: int
+    minor: int
+    micro: int
+    releaselevel: Literal["alpha", "beta", "candidate", "final"]
+    serial: int
+
+version_info: VersionInfo

pyproject.toml

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: MIT
 
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "versioningit>=3.3.0"]
 build-backend = "hatchling.build"
 
 [project]
@@ -125,10 +125,47 @@ test = { cmd = "nox -Rs test --", help = "Run pytest" }
 include = [
     "disnake/",
 ]
+artifacts = ["disnake/_version.py"]
 
 [tool.hatch.version]
-path = "disnake/__init__.py"
-pattern = '__version__ = "(?P<version>.+)"'
+source = "versioningit"
+
+[tool.versioningit.vcs]
+method = "git-archive"
+describe-subst = "$Format:%(describe:tags,match=v*)$"
+
+[tool.versioningit.format]
+distance = "{base_version}+{distance}.{vcs}{rev}"
+dirty = "{base_version}+d{build_date:%Y%m%d}"
+distance-dirty = "{base_version}.a{distance}+{vcs}{rev}.d{build_date:%Y%m%d}"
+
+[tool.versioningit.template-fields.version-tuple]
+split-on = '^(\d+)\.(\d+)\.(\d+)\.([a-zA-Z])(\d+)(?:.\d+)?'
+
+
+[tool.versioningit.write]
+file = "disnake/_version.py"
+template = """
+# SPDX-License-Identifier: MIT
+
+from typing import Literal, NamedTuple
+
+__version__ = "{version}"
+
+
+class VersionInfo(NamedTuple):
+    major: int
+    minor: int
+    micro: int
+    releaselevel: Literal["alpha", "beta", "candidate", "final"]
+    serial: int
+
+
+# fmt: off
+version_info: VersionInfo = VersionInfo(*{version_tuple}[:5])
+# fmt: on
+
+"""
 
 [tool.ruff]
 line-length = 100