Improve the CI (#411)

.github/workflows/check.yaml

@@ -0,0 +1,56 @@
+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:
+ - "pypy-3.10"
+ - "pypy-3.9"
+ - "3.13"
+ - "3.12"
+ - "3.11"
+ - "3.10"
+ - "3.9"
+ - "3.8"
+ - type
+ - dev
+ - pkg_meta
+ steps:
+ - name: Install OS dependencies
+ run: sudo apt-get install graphviz -y
+ - 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.') || startsWith(matrix.env, 'pypy-')) && 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_AGAINST: HEAD

.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/pipdeptree/${{ 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

tox.ini

@@ -11,28 +11,29 @@ env_list =
  3.9
  3.8
  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 =
  graphviz
  test
+pass_env =
+ DIFF_AGAINST
+ 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 =
  python -m pytest {tty:--color=yes} {posargs: \
- --cov {envsitepackagesdir}{/}pipdeptree --cov {toxinidir}{/}tests \
+ --cov {env_site_packages_dir}{/}pipdeptree --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 \
- --junitxml {toxworkdir}{/}junit.{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}
- diff-cover --compare-branch {env:DIFF_AGAINST:origin/main} {toxworkdir}{/}coverage.{envname}.xml --fail-under 100
+ diff-cover --compare-branch {env:DIFF_AGAINST:origin/main} {work_dir}{/}coverage.{env_name}.xml --fail-under 100
 
 [testenv:fix]
 description = format the code base to adhere to our styles, and complain about what we cannot do automatically
@@ -50,15 +51,17 @@ commands =
  mypy src
  mypy tests
 
-[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 --sdist --wheel -o {envtmpdir} .
- twine check {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