chore: Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 0.10.14
+_commit: 0.16.6
 _src_path: gh:pawamoy/copier-pdm
 author_email: pawamoy@pm.me
 author_fullname: Timothée Mazzucotelli
@@ -8,6 +8,7 @@ copyright_date: '2023'
 copyright_holder: Timothée Mazzucotelli
 copyright_holder_email: pawamoy@pm.me
 copyright_license: ISC License
+insiders: false
 project_description: Griffe extension for @tiangolo's `typing.doc` PEP.
 project_name: Griffe TypingDoc
 python_package_command_line_name: ''
@@ -16,5 +17,4 @@ python_package_import_name: griffe_typingdoc
 repository_name: griffe-typingdoc
 repository_namespace: pawamoy
 repository_provider: github.com
-use_precommit: false
 

.github/FUNDING.yml

@@ -1,4 +1,4 @@
-github:
-- pawamoy
+github: pawamoy
+ko_fi: pawamoy
 custom:
 - https://www.paypal.me/pawamoy

.github/workflows/ci.yml

@@ -2,11 +2,9 @@ name: ci
 
 on:
   push:
-    branches:
-      - master
   pull_request:
     branches:
-      - master
+    - main
 
 defaults:
   run:
@@ -27,16 +25,19 @@ 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:
         python-version: "3.9"
 
     - name: Resolving dependencies
-      run: pdm lock -v
+      run: pdm lock -v --no-cross-platform -G ci-quality
 
     - name: Install dependencies
-      run: pdm install -G duty -G docs -G quality -G typing -G security
+      run: pdm install -G ci-quality
 
     - name: Check if the documentation builds correctly
       run: pdm run duty check-docs
@@ -50,20 +51,26 @@ jobs:
     - name: Check for vulnerabilities in dependencies
       run: pdm run duty check-dependencies
 
+    - name: Check for breaking changes in the API
+      run: pdm run duty check-api
+
   tests:
 
     strategy:
+      max-parallel: 4
       matrix:
         os:
         - ubuntu-latest
         - macos-latest
         - windows-latest
         python-version:
+        - "3.8"
         - "3.9"
         - "3.10"
         - "3.11"
-
+        - "3.12"
     runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.python-version == '3.12' }}
 
     steps:
     - name: Checkout
@@ -73,12 +80,13 @@ jobs:
       uses: pdm-project/setup-pdm@v3
       with:
         python-version: ${{ matrix.python-version }}
+        allow-python-prereleases: true
 
     - name: Resolving dependencies
-      run: pdm lock -v
+      run: pdm lock -v --no-cross-platform -G ci-tests
 
     - name: Install dependencies
-      run: pdm install --no-editable -G duty -G tests
+      run: pdm install --no-editable -G ci-tests
 
     - name: Run the test suite
       run: pdm run duty test

.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

.gitignore

@@ -11,6 +11,9 @@ pip-wheel-metadata/
 .mypy_cache/
 site/
 pdm.lock
-.pdm.toml
+pdm.toml
+.pdm-plugins/
+.pdm-python
 __pypackages__/
 .venv/
+.cache/

.gitpod.dockerfile

@@ -1,7 +1,6 @@
 FROM gitpod/workspace-full
 USER gitpod
 ENV PIP_USER=no
-ENV PYTHON_VERSIONS=
 RUN pip3 install pipx; \
     pipx install pdm; \
     pipx ensurepath

CONTRIBUTING.md

@@ -32,29 +32,26 @@ make setup
 
 You now have the dependencies installed.
 
-You can run the application with `pdm run  [ARGS...]`.
-
 Run `make help` to see all the available actions!
 
 ## Tasks
 
 This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
 A Makefile is also provided. The Makefile will try to run certain tasks
 on multiple Python versions. If for some reason you don't want to run the task
-on multiple Python versions, you can do one of the following:
-
-1. `export PYTHON_VERSIONS= `: this will run the task
-   with only the current Python version
-2. run the task directly with `pdm run duty TASK`
+on multiple Python versions, you run the task directly with `pdm run duty TASK`.
 
 The Makefile detects if a virtual environment is activated,
 so `make` will work the same with the virtualenv activated or not.
 
+If you work in VSCode,
+[see examples of tasks and run configurations](https://pawamoy.github.io/copier-pdm/work/#vscode-setup).
+
 ## Development
 
 As usual:
 
-1. create a new branch: `git checkout -b feature-or-bugfix-name`
+1. create a new branch: `git switch -c feature-or-bugfix-name`
 1. edit the code and/or the documentation
 
 **Before committing:**
@@ -63,7 +60,7 @@ As usual:
 1. run `make check` to check everything (fix any warning)
 1. run `make test` to run the tests (fix any issue)
 1. if you updated the documentation or the project dependencies:
-    1. run `make docs-serve`
+    1. run `make docs`
     1. go to http://localhost:8000 and check that everything looks good
 1. follow our [commit message convention](#commit-message-convention)
 
@@ -140,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,24 +1,22 @@
 .DEFAULT_GOAL := help
 SHELL := bash
-
-DUTY = $(shell [ -n "${VIRTUAL_ENV}" ] || echo pdm run) duty
-PYTHON_VERSIONS = 3.9 3.10 3.11
+DUTY := $(if $(VIRTUAL_ENV),,pdm run) duty
+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
-docs_serve_args = host port
+docs_args = host port
 release_args = version
 test_args = match
 
 BASIC_DUTIES = \
 	changelog \
+	check-api \
 	check-dependencies \
 	clean \
 	coverage \
 	docs \
 	docs-deploy \
-	docs-regen \
-	docs-serve \
 	format \
 	release
 
@@ -34,16 +32,16 @@ help:
 
 .PHONY: lock
 lock:
-	@pdm lock
+	@pdm lock -G:all
 
 .PHONY: setup
 setup:
 	@bash scripts/setup.sh
 
 .PHONY: check
 check:
-	@pdm multirun -i 3.9,3.10,3.11 duty check-quality check-types check-docs
-	@$(DUTY) check-dependencies
+	@pdm multirun duty check-quality check-types check-docs
+	@$(DUTY) check-dependencies check-api
 
 .PHONY: $(BASIC_DUTIES)
 $(BASIC_DUTIES):

README.md

@@ -17,7 +17,7 @@ pip install griffe-typingdoc
 
 With [`pipx`](https://github.com/pipxproject/pipx):
 ```bash
-python3.7 -m pip install --user pipx
+python3.8 -m pip install --user pipx
 pipx install griffe-typingdoc
 ```
 

config/black.toml

@@ -0,0 +1,3 @@
+[tool.black]
+line-length = 120
+exclude = "tests/fixtures"