chore: Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 0.15.21
+_commit: 0.16.5
 _src_path: gh:pawamoy/copier-pdm
 author_email: pawamoy@pm.me
 author_fullname: Timothée Mazzucotelli

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on:
   push:
   pull_request:
     branches:
-      - master
+    - main
 
 defaults:
   run:
@@ -25,6 +25,9 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v3
 
+    - name: Fetch all tags
+      run: git fetch --depth=1 --tags
+
     - name: Set up PDM
       uses: pdm-project/setup-pdm@v3
       with:
@@ -77,6 +80,7 @@ jobs:
       uses: pdm-project/setup-pdm@v3
       with:
         python-version: ${{ matrix.python-version }}
+        allow-python-prereleases: true
 
     - name: Resolving dependencies
       run: pdm lock -v --no-cross-platform -G ci-tests

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: release
+
+on: push
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Fetch all tags
+      run: git fetch --depth=1 --tags
+    - name: Setup Python
+      uses: actions/setup-python@v4
+    - name: Install git-changelog
+      run: pip install git-changelog
+    - name: Prepare release notes
+      run: git-changelog --release-notes > release-notes.md
+    - name: Create release
+      uses: softprops/action-gh-release@v1
+      with:
+        body_path: release-notes.md

CONTRIBUTING.md

@@ -137,7 +137,7 @@ git commit --fixup=SHA
 Once all the changes are approved, you can squash your commits:
 
 ```bash
-git rebase -i --autosquash master
+git rebase -i --autosquash main
 ```
 
 And force-push:

Makefile

@@ -1,7 +1,7 @@
 .DEFAULT_GOAL := help
 SHELL := bash
 DUTY := $(if $(VIRTUAL_ENV),,pdm run) duty
-export PDM_MULTIRUN_VERSIONS ?= 3.8 3.9 3.10 3.11
+export PDM_MULTIRUN_VERSIONS ?= 3.8 3.9 3.10 3.11 3.12
 
 args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)"))
 check_quality_args = files

config/ruff.toml

@@ -1,4 +1,4 @@
-target-version = "py37"
+target-version = "py38"
 line-length = 132
 exclude = [
     "fixtures",

duties.py

@@ -53,10 +53,10 @@ def merge(d1: Any, d2: Any) -> Any:  # noqa: D103
 
 
 def mkdocs_config() -> str:  # noqa: D103
-    from mkdocs import utils
+    import mergedeep
 
-    # patch YAML loader to merge arrays
-    utils.merge = merge
+    # force YAML loader to merge arrays
+    mergedeep.merge = merge
 
     if "+insiders" in pkgversion("mkdocs-material"):
         return "mkdocs.insiders.yml"
@@ -108,6 +108,7 @@ def check_quality(ctx: Context) -> None:
     ctx.run(
         ruff.check(*PY_SRC_LIST, config="config/ruff.toml"),
         title=pyprefix("Checking code quality"),
+        command=f"ruff check --config config/ruff.toml {PY_SRC}",
     )
 
 
@@ -125,7 +126,11 @@ def check_dependencies(ctx: Context) -> None:
         allow_overrides=False,
     )
 
-    ctx.run(safety.check(requirements), title="Checking dependencies")
+    ctx.run(
+        safety.check(requirements),
+        title="Checking dependencies",
+        command="pdm export -f requirements --without-hashes | safety check --stdin",
+    )
 
 
 @duty
@@ -137,7 +142,12 @@ def check_docs(ctx: Context) -> None:
     """
     Path("htmlcov").mkdir(parents=True, exist_ok=True)
     Path("htmlcov/index.html").touch(exist_ok=True)
-    ctx.run(mkdocs.build(strict=True, config_file=mkdocs_config()), title=pyprefix("Building documentation"))
+    config = mkdocs_config()
+    ctx.run(
+        mkdocs.build(strict=True, config_file=config, verbose=True),
+        title=pyprefix("Building documentation"),
+        command=f"mkdocs build -vsf {config}",
+    )
 
 
 @duty
@@ -150,6 +160,7 @@ def check_types(ctx: Context) -> None:
     ctx.run(
         mypy.run(*PY_SRC_LIST, config_file="config/mypy.ini"),
         title=pyprefix("Type-checking"),
+        command=f"mypy --config-file config/mypy.ini {PY_SRC}",
     )
 
 
@@ -164,8 +175,9 @@ def check_api(ctx: Context) -> None:
 
     griffe_check = lazy(g_check, name="griffe.check")
     ctx.run(
-        griffe_check("mkdocs_autorefs", search_paths=["src"]),
+        griffe_check("mkdocs_autorefs", search_paths=["src"], color=True),
         title="Checking for API breaking changes",
+        command="griffe check -ssrc mkdocs_autorefs",
         nofail=True,
     )
 
@@ -281,4 +293,5 @@ def test(ctx: Context, match: str = "") -> None:
     ctx.run(
         pytest.run("-n", "auto", "tests", config_file="config/pytest.ini", select=match, color="yes"),
         title=pyprefix("Running tests"),
+        command=f"pytest -c config/pytest.ini -n auto -k{match!r} --color=yes tests",
     )

mkdocs.yml

@@ -6,6 +6,12 @@ repo_name: "mkdocstrings/autorefs"
 site_dir: "site"
 watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src/mkdocs_autorefs]
 copyright: Copyright © 2019 Oleh Prypin, Timothée Mazzucotelli
+edit_uri: edit/main/docs/
+
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
 
 nav:
 - Home:

pyproject.toml

@@ -25,6 +25,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Documentation",
     "Topic :: Software Development",
     "Topic :: Software Development :: Documentation",
@@ -66,7 +67,7 @@ docs = [
     "black>=23.1",
     "markdown-callouts>=0.2",
     "markdown-exec>=0.5",
-    "mkdocs>=1.3",
+    "mkdocs>=1.5",
     "mkdocs-coverage>=0.2",
     "mkdocs-gen-files>=0.3",
     "mkdocs-git-committers-plugin-2>=1.1",