build: copier-auto-update

Author: KyleKing

.copier-answers.yml

@@ -2,7 +2,7 @@
 # Answer file maintained by Copier for: https://github.com/KyleKing/mdformat-plugin-template
 # DO NOT MODIFY THIS FILE. Edit by re-running copier and changing responses to the questions
 # Check into version control.
-_commit: 2.1.2
+_commit: 2.2.0
 _src_path: gh:KyleKing/mdformat-plugin-template
 author_email: [email protected]
 author_name: Kyle King

.github/workflows/tests.yml

@@ -26,67 +26,53 @@ jobs:
         os: [ubuntu-latest, windows-latest]
     steps:
       - uses: actions/checkout@v5
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Installation (deps and package)
-        # We install with flit --pth-file, so that coverage will be recorded for the module
-        # Flit could be installed with pipx and use '--python=$(which python)', but
-        #  there were issues with the Windows Runner
-        run: |
-          pip install flit~=3.10.1
-          flit install --deps=production --extras=test --pth-file
+      - name: Install Package
+        run: uv pip install --system ".[test]"
       - name: Run pytest
-        run: |
-          pytest --cov
-      # # Not currently configured
-      # - name: Report coverage
-      #   if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
-      #   uses: codecov/codecov-action@v4
-      #   with:
-      #     token: ${{ secrets.CODECOV_TOKEN }}
+        run: pytest --cov
 
   prek-hook:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Set up Python
-        uses: actions/setup-python@v6
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: 3.12
-      - name: Installation (deps and package)
-        run: |
-          pip install flit~=3.10.1
-          flit install --deps=production --pth-file
       - name: Install prek
         uses: j178/prek-action@v1
         with:
           install-only: true
+      - name: Install Package
+        run: uv pip install --system ".[test]"
       - name: run prek with plugin
-        run: |
-          prek run --config .prek-test.yaml --all-files --verbose --show-diff-on-failure
+        run: prek run --config .pre-commit-test.yaml --all-files --verbose --show-diff-on-failure
 
   publish:
     name: Publish to PyPi
     needs: [prek, tests, prek-hook]
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
-    # Fix 403 error (https://github.com/softprops/action-gh-release/issues/400)
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mdformat-mkdocs
     permissions:
-      contents: write
+      contents: write  # For GitHub release creation
+      id-token: write  # IMPORTANT: mandatory for PyPI trusted publishing
     steps:
-      - name: Checkout source
-        uses: actions/checkout@v5
-      - name: install flit
-        run: |
-          pipx install flit~=3.10.1
-      - name: Build and publish
-        run: |
-          flit publish
-        env:
-          FLIT_USERNAME: __token__
-          FLIT_PASSWORD: ${{ secrets.PYPI_KEY }}
+      - uses: actions/checkout@v5
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: 3.12
+      - name: Build Package
+        run: uv build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
       - name: Generate GitHub Release Notes
         uses: softprops/action-gh-release@v2
         with:

.pre-commit-config.yaml

@@ -41,7 +41,7 @@ repos:
       - id: yamllint
         stages: ["pre-commit"]
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.30.0
+    rev: 0.35.0
     hooks:
       - id: check-github-workflows
         args: ["--verbose"]

AGENTS.md

@@ -112,7 +112,7 @@ Configuration can be passed via:
 
 ## Development Notes
 
-- This project uses `flit` as the build backend
+- This project uses `uv-build` as the build backend
 - Uses `tox` for test automation with multiple Python versions (3.10, 3.12)
 - Pre-commit is configured but the project now uses `prek` (faster alternative)
 - Python 3.10+ is required (see `requires-python` in `pyproject.toml`)

CONTRIBUTING.md

@@ -9,7 +9,7 @@ A collection of useful resources to reference when developing new features:
 
 ## Local Development
 
-This package utilizes [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.
+This package utilizes [uv](https://docs.astral.sh/uv) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.
 
 To install these development dependencies:
 
@@ -35,7 +35,7 @@ The easiest way to write tests, is to edit `tests/fixtures.md`
 To run the code formatting and style checks:
 
 ```bash
-tox -e py312-pre-commit
+tox -e py312-prek
 ```
 
 or directly with [prek](https://github.com/j178/prek) (or pre-commit)
@@ -79,21 +79,59 @@ Or with pipx:
 pipx install . --include-deps --force --editable
 ```
 
-## Publish to PyPi
+## Publish to PyPI
 
-First, update the version in `mdformat_mkdocs/__init__.py`
+This project uses [PyPI Trusted Publishers](https://docs.pypi.org/trusted-publishers) for secure, token-free publishing from GitHub Actions, with [uv](https://docs.astral.sh/uv) for building packages.
 
-Then, either use the Github Action by committing the new version in `__init__.py` and pushing an associated tag in format: `v#.#.#` (e.g. `v1.3.2` for `__version__ = '1.3.2'`)
+### Initial Setup (One-time)
 
-Or run flit locally:
+Before publishing for the first time, you need to configure Trusted Publishing on PyPI:
 
-```bash
-# envchain --set FLIT FLIT_PASSWORD
-export FLIT_USERNAME=__token__
-export eval $(envchain FLIT env | grep FLIT_PASSWORD=)
+1. Go to your project's page on PyPI: `https://pypi.org/manage/project/mdformat_mkdocs/settings/publishing/`
+    - If the project doesn't exist yet, go to [PyPI's publishing page](https://pypi.org/manage/account/publishing) to add a "pending" publisher
+1. Add a new Trusted Publisher with these settings:
+    - **PyPI Project Name**: `mdformat_mkdocs`
+    - **Owner**: `kyleking`
+    - **Repository name**: `mdformat-mkdocs`
+    - **Workflow name**: `tests.yml` (`.github/workflows/tests.yml`)
+    - **Environment name**: `pypi`
+1. Configure the GitHub Environment:
+    - Go to your repository's `Settings` → `Environments`
+    - Create an environment named `pypi`
+    - (Recommended) Enable "Required reviewers" for production safety
+
+### Publishing a Release
+
+#### Option 1: Using commitizen (Recommended)
+
+Use commitizen to automatically bump versions and create a commit with tag:
+
+```sh
+# Dry run to preview the version bump
+tox -e py312-cz -- --dry-run
+
+# Automatically bump version based on conventional commits
+tox -e py312-cz
 
-flit publish
+# Or manually specify the increment type
+tox -e py312-cz -- --increment PATCH  # or MINOR or MAJOR
+
+# Push the commit and tag
+git push origin main --tags
+```
+
+Commitizen will automatically update versions in `pyproject.toml` and `mdformat_mkdocs/__init__.py`.
+
+#### Option 2: Manual Version Bump
+
+Update the versions in both `pyproject.toml` under `[project].version` and `mdformat_mkdocs/__init__.py` for `__version__`. Commit the change and push a tag in the form `vX.Y.Z` (for example, `v1.3.2` when the project version is `1.3.2`):
+
+```sh
+TAG=1.3.2
+git add pyproject.toml mdformat_mkdocs/__init__.py
+git commit -m "release: v$TAG"
+git tag v$TAG
+git push origin main --tags
 ```
 
-> [!NOTE]
-> The Github Action requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`
+The GitHub Action will automatically build and publish to PyPI using Trusted Publishers (no API tokens needed!).

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
-build-backend = "flit_core.buildapi"
-requires = ["flit_core >=3.9.0,<4"]
+build-backend = "uv_build"
+requires = ["uv_build>=0.9.10"]
 
 [project]
 authors = [
@@ -18,11 +18,13 @@ dependencies = [
   "mdit-py-plugins >= 0.4.1",
   "more-itertools >= 10.5.0",
 ]
-dynamic = ["description", "version"]
 keywords = ["markdown", "markdown-it", "mdformat", "mdformat_plugin_template"]
+license = "MIT"
+license-files = ["LICENSE"]
 name = "mdformat_mkdocs"
 readme = "README.md"
 requires-python = ">=3.10.0"
+version = "4.5.0"
 
 [project.entry-points."mdformat.parser_extension"]
 mkdocs = "mdformat_mkdocs"
@@ -45,9 +47,9 @@ recommended = [
 ]
 test = [
   "beartype >= 0.21.0",
-  "pytest >= 8.3.4",
+  "pytest >= 9.0.1",
   "pytest-beartype >= 0.2.0",
-  "pytest-cov >= 6.2.1",
+  "pytest-cov >= 7.0.0",
   "syrupy >= 4.9.1",
 ]
 
@@ -56,9 +58,10 @@ test = [
 "Changelog" = "https://github.com/kyleking/mdformat-mkdocs/releases"
 homepage = "https://github.com/kyleking/mdformat-mkdocs"
 
-[tool.flit.sdist]
-exclude = [".github/", "tests/"]
-include = []
+[tool.commitizen]
+tag_format = "v${version}"
+version = "4.5.0"
+version_files = ["mdformat_mkdocs/__init__.py", "pyproject.toml:^version"]
 
 [tool.mypy]
 check_untyped_defs = true
@@ -166,7 +169,7 @@ inline_arrays = false
 [tool.tox]
 # Docs: https://tox.wiki/en/4.23.2/config.html#core
 basepython = ["python3.10", "python3.12"]
-env_list = ["py310-hook", "py310-test", "py312-prek", "py312-ruff", "py312-test", "py312-type"]
+env_list = ["py310-hook", "py310-test", "py312-cz", "py312-prek", "py312-ruff", "py312-test", "py312-type"]
 isolated_build = true
 requires = ["tox>=4.32.0"]
 skip_missing_interpreters = false
@@ -179,6 +182,12 @@ deps = "prek>=0.2.17"
 commands = [["pytest", "--cov=mdformat_mkdocs"]]
 extras = ["test"]
 
+[tool.tox.env."py312-cz"]
+commands = [["cz", "bump", {default = [], extend = true, replace = "posargs"}]]
+deps = "commitizen>=4.10.0"
+description = "Bump version using commitizen. Optionally specify: '-- --increment MAJOR|MINOR|PATCH' or '-- --dry-run'"
+skip_install = true
+
 [tool.tox.env."py312-prek"]
 commands = [["prek", "run", "--all-files", {default = [], extend = true, replace = "posargs"}]]
 deps = "prek>=0.2.17"
@@ -207,3 +216,6 @@ deps = ["mypy>=1.18.2"]
 [tool.tox.env_run_base]
 # Validates that commands are set
 commands = [["error-commands-are-not-set"]]
+
+[tool.uv.build-backend]
+module-root = ""