chore: Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 1.2.0
+_commit: 1.2.4
 _src_path: gh:mkdocstrings/handler-template
 author_email: [email protected]
 author_fullname: Timothée Mazzucotelli

.github/workflows/ci.yml

@@ -25,9 +25,9 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
-
-    - name: Fetch all tags
-      run: git fetch --depth=1 --tags
+      with:
+        fetch-depth: 0
+        fetch-tags: true
 
     - name: Setup Python
       uses: actions/setup-python@v5
@@ -105,6 +105,9 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        fetch-tags: true
 
     - name: Setup Python
       uses: actions/setup-python@v5

.github/workflows/release.yml

@@ -11,8 +11,9 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v4
-    - name: Fetch all tags
-      run: git fetch --depth=1 --tags
+      with:
+        fetch-depth: 0
+        fetch-tags: true
     - name: Setup Python
       uses: actions/setup-python@v5
       with:

README.md

@@ -3,7 +3,6 @@
 [![ci](https://github.com/mkdocstrings/shell/workflows/ci/badge.svg)](https://github.com/mkdocstrings/shell/actions?query=workflow%3Aci)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/shell/)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-shell.svg)](https://pypi.org/project/mkdocstrings-shell/)
-[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/shell)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#shell:gitter.im)
 
 A shell scripts/libraries handler for mkdocstrings.

docs/insiders/index.md

@@ -88,6 +88,8 @@ else:
 ```
 <!-- blacken-docs:on -->
 
+Additionally, your sponsorship will give more weight to your upvotes on issues, helping us prioritize work items in our backlog. For more information on how we prioritize work, see this page: [Backlog management](https://pawamoy.github.io/backlog/).
+
 ## How to become a sponsor
 
 Thanks for your interest in sponsoring! In order to become an eligible sponsor

duties.py

@@ -85,6 +85,7 @@ def check_docs(ctx: Context) -> None:
 def check_types(ctx: Context) -> None:
     """Check that the code is correctly typed."""
     os.environ["MYPYPATH"] = "src"
+    os.environ["FORCE_COLOR"] = "1"
     ctx.run(
         tools.mypy(*PY_SRC_LIST, config_file="config/mypy.ini"),
         title=pyprefix("Type-checking"),

pyproject.toml

@@ -43,13 +43,16 @@ Discussions = "https://github.com/mkdocstrings/shell/discussions"
 Gitter = "https://gitter.im/mkdocstrings/shell"
 Funding = "https://github.com/sponsors/pawamoy"
 
-[tool.pdm]
-version = {source = "scm"}
+[tool.pdm.version]
+source = "call"
+getter = "scripts.get_version:get_version"
 
 [tool.pdm.build]
 package-dir = "src"
 includes = ["src/mkdocstrings_handlers"]
 editable-backend = "editables"
+
+# Include as much as possible in the source distribution, to help redistributors.
 excludes = ["**/.pytest_cache"]
 source-includes = [
     "config",
@@ -64,15 +67,15 @@ source-includes = [
 ]
 
 [tool.pdm.build.wheel-data]
+# Manual pages can be included in the wheel.
+# Depending on the installation tool, they will be accessible to users.
+# pipx supports it, uv does not yet, see https://github.com/astral-sh/uv/issues/4731.
 data = [
     {path = "share/**/*", relative-to = "."},
 ]
 
-[tool.uv]
-dev-dependencies = [
-    # dev
-    "editables>=0.5",
-
+[dependency-groups]
+dev = [
     # maintenance
     "build>=1.2",
     "git-changelog>=2.5",

scripts/gen_credits.py

@@ -27,7 +27,7 @@
     pyproject = tomllib.load(pyproject_file)
 project = pyproject["project"]
 project_name = project["name"]
-devdeps = [dep for dep in pyproject["tool"]["uv"]["dev-dependencies"] if not dep.startswith("-e")]
+devdeps = [dep for dep in pyproject["dependency-groups"]["dev"] if not dep.startswith("-e")]
 
 PackageMetadata = dict[str, Union[str, Iterable[str]]]
 Metadata = dict[str, PackageMetadata]

scripts/get_version.py

@@ -0,0 +1,27 @@
+"""Get current project version from Git tags or changelog."""
+
+import re
+from contextlib import suppress
+from pathlib import Path
+
+from pdm.backend.hooks.version import SCMVersion, Version, default_version_formatter, get_version_from_scm
+
+_root = Path(__file__).parent.parent
+_changelog = _root / "CHANGELOG.md"
+_changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
+_default_scm_version = SCMVersion(Version("0.0.0"), None, False, None, None)  # noqa: FBT003
+
+
+def get_version() -> str:
+    """Get current project version from Git tags or changelog."""
+    scm_version = get_version_from_scm(_root) or _default_scm_version
+    if scm_version.version <= Version("0.1"):  # Missing Git tags?
+        with suppress(OSError, StopIteration):  # noqa: SIM117
+            with _changelog.open("r", encoding="utf8") as file:
+                match = next(filter(None, map(_changelog_version_re.match, file)))
+                scm_version = scm_version._replace(version=Version(match.group(1)))
+    return default_version_formatter(scm_version)
+
+
+if __name__ == "__main__":
+    print(get_version())

scripts/insiders.py

@@ -26,7 +26,7 @@
 def human_readable_amount(amount: int) -> str:  # noqa: D103
     str_amount = str(amount)
     if len(str_amount) >= 4:  # noqa: PLR2004
-        return f"{str_amount[:len(str_amount)-3]},{str_amount[-3:]}"
+        return f"{str_amount[: len(str_amount) - 3]},{str_amount[-3:]}"
     return str_amount
 
 

scripts/make

@@ -0,0 +1 @@
+make.py