Improve the CI (#187)

gaborbernat · web-flow · commit 000e0a0f1b97 · 2024-09-17T17:04:49.000-07:00
diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml
@@ -0,0 +1,49 @@
+name: check
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+    tags-ignore: ["**"]
+  pull_request:
+  schedule:
+    - cron: "0 8 * * *"
+
+concurrency:
+  group: check-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        env:
+          - "3.13"
+          - "3.12"
+          - "3.11"
+          - "3.10"
+          - type
+          - dev
+          - pkg_meta
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install tox
+        run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
+      - name: Install Python
+        if: startsWith(matrix.env, '3.') && matrix.env != '3.13'
+        run: uv python install --python-preference only-managed ${{ matrix.env }}
+      - name: Setup test suite
+        run: tox run -vv --notest --skip-missing-interpreters false -e ${{ matrix.env }}
+      - name: Run test suite
+        run: tox run --skip-pkg-install -e ${{ matrix.env }}
+        env:
+          PYTEST_ADDOPTS: "-vv --durations=20"
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,48 @@
+name: Release to PyPI
+on:
+  push:
+    tags: ["*"]
+
+env:
+  dists-artifact-name: python-package-distributions
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build package
+        run: uv build --python 3.13 --python-preference only-managed --sdist --wheel . --out-dir dist
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/*
+
+  release:
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+      url: https://pypi.org/project/sphinx-argparse-cli/${{ github.ref_name }}
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.10.1
+        with:
+          attestations: true
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-argparse-cli?style=flat-square)](https://pypi.org/project/sphinx-argparse-cli)
 [![Downloads](https://static.pepy.tech/badge/sphinx-argparse-cli/month)](https://pepy.tech/project/sphinx-argparse-cli)
 [![PyPI - License](https://img.shields.io/pypi/l/sphinx-argparse-cli?style=flat-square)](https://opensource.org/licenses/MIT)
-![check](https://github.com/tox-dev/sphinx-argparse-cli/workflows/check/badge.svg?branch=main)
+[![check](https://github.com/tox-dev/sphinx-argparse-cli/actions/workflows/check.yaml/badge.svg)](https://github.com/tox-dev/sphinx-argparse-cli/actions/workflows/check.yaml)
 
 Render CLI arguments (sub-commands friendly) defined by the argparse module. For live demo checkout the documentation of
 [tox](https://tox.wiki/en/latest/cli_interface.html),
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,7 @@ dynamic = [
 dependencies = [
   "sphinx>=8.0.2",
 ]
-optional-dependencies.test = [
+optional-dependencies.testing = [
   "covdefaults>=2.3",
   "defusedxml>=0.7.1", # needed for sphinx.testing
   "pytest>=8.3.2",
diff --git a/tox.ini b/tox.ini
@@ -1,73 +1,66 @@
 [tox]
 requires =
     tox>=4.2
+    tox-uv>=1.11.3
 env_list =
     fix
     3.13
     3.12
     3.11
     3.10
     type
-    readme
+    pkg_meta
 skip_missing_interpreters = true
 
 [testenv]
-description = run the unit tests with pytest under {basepython}
+description = run the unit tests with pytest under {base_python}
 package = wheel
 wheel_build_env = .pkg
 extras =
-    test
+    testing
+pass_env =
+    PYTEST_*
 set_env =
-    COVERAGE_FILE = {toxworkdir}/.coverage.{envname}
-    COVERAGE_PROCESS_START = {toxinidir}/setup.cfg
-    _COVERAGE_SRC = {envsitepackagesdir}/sphinx_argparse_cli
+    COVERAGE_FILE = {work_dir}/.coverage.{env_name}
 commands =
-    pytest {tty:--color=yes} {posargs: \
-      --junitxml {toxworkdir}{/}junit.{envname}.xml --cov {envsitepackagesdir}{/}sphinx_argparse_cli \
-      --cov {toxinidir}{/}tests --cov-fail-under=100 \
+    python -m pytest {tty:--color=yes} {posargs: \
+      --cov {env_site_packages_dir}{/}sphinx_argparse_cli --cov {tox_root}{/}tests \
       --cov-config=pyproject.toml --no-cov-on-fail --cov-report term-missing:skip-covered --cov-context=test \
-      --cov-report html:{envtmpdir}{/}htmlcov --cov-report xml:{toxworkdir}{/}coverage.{envname}.xml \
+      --cov-report html:{env_tmp_dir}{/}htmlcov --cov-report xml:{work_dir}{/}coverage.{env_name}.xml \
+      --junitxml {work_dir}{/}junit.{env_name}.xml \
       tests}
 
 [testenv:fix]
-description = run static analysis and style check using flake8
+description = format the code base to adhere to our styles, and complain about what we cannot do automatically
 skip_install = true
 deps =
-    pre-commit>=3.8
-pass_env =
-    HOMEPATH
-    PROGRAMDATA
+    pre-commit-uv>=4.1.1
 commands =
     pre-commit run --all-files --show-diff-on-failure
-    python -c 'print("hint: run {envdir}/bin/pre-commit install to add checks as pre-commit hook")'
 
 [testenv:type]
 description = run type check on code base
 deps =
     mypy==1.11.2
     types-docutils>=0.21.0.20240907
 commands =
-    mypy src
-    mypy tests
+    mypy src tests {posargs}
 
-[testenv:readme]
+[testenv:pkg_meta]
 description = check that the long description is valid
 skip_install = true
 deps =
-    build[uv]>=1.2.2
     check-wheel-contents>=0.6
     twine>=5.1.1
+    uv>=0.4.10
 commands =
-    pyproject-build --installer uv --outdir {envtmpdir} --sdist --wheel .
-    twine check {envtmpdir}{/}*
-    check-wheel-contents --no-config {envtmpdir}
+    uv build --sdist --wheel --out-dir {env_tmp_dir} .
+    twine check {env_tmp_dir}{/}*
+    check-wheel-contents --no-config {env_tmp_dir}
 
 [testenv:dev]
 description = generate a DEV environment
 package = editable
-extras =
-    docs
-    test
 commands =
     uv pip tree
     python -c 'import sys; print(sys.executable)'

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ dynamic = [`
`41`	`41`	`dependencies = [`
`42`	`42`	`"sphinx>=8.0.2",`
`43`	`43`	`]`
`44`		`-optional-dependencies.test = [`
	`44`	`+optional-dependencies.testing = [`
`45`	`45`	`"covdefaults>=2.3",`
`46`	`46`	`"defusedxml>=0.7.1", # needed for sphinx.testing`
`47`	`47`	`"pytest>=8.3.2",`