From b28a0ceb597c282857c71ce7728e8aa36519e1ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= Date: Tue, 17 Sep 2024 15:35:02 -0700 Subject: [PATCH] Improve the CI (#411) --- .github/workflows/check.yaml | 56 +++++++++++++++++++++++++ .github/workflows/check.yml | 75 ---------------------------------- .github/workflows/release.yaml | 48 ++++++++++++++++++++++ .github/workflows/release.yml | 27 ------------ tox.ini | 29 +++++++------ 5 files changed, 120 insertions(+), 115 deletions(-) create mode 100644 .github/workflows/check.yaml delete mode 100644 .github/workflows/check.yml create mode 100644 .github/workflows/release.yaml delete mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml new file mode 100644 index 0000000..687a606 --- /dev/null +++ b/.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 diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml deleted file mode 100644 index 227c086..0000000 --- a/.github/workflows/check.yml +++ /dev/null @@ -1,75 +0,0 @@ -name: check -on: - workflow_dispatch: - push: - branches: ["main"] - pull_request: - schedule: - - cron: "0 8 * * *" - -concurrency: - group: check-${{ github.ref }} - cancel-in-progress: true - -jobs: - test: - name: test ${{ matrix.py }} - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - py: - - "pypy3.10" - - "pypy3.9" - - "3.13" - - "3.12" - - "3.11" - - "3.10" - - "3.9" - - "3.8" - steps: - - name: Install OS dependencies - run: sudo apt-get install graphviz -y - - name: setup python for tox - uses: actions/setup-python@v5 - with: - python-version: "3.12" - - name: install tox - run: python -m pip install tox-uv - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: setup python for test ${{ matrix.py }} - uses: actions/setup-python@v5 - with: - python-version: ${{ matrix.py }} - allow-prereleases: true - - name: Pick environment to run - run: echo "TOXENV=`echo ${{ matrix.py }} | sed 's/pypy3\./pypy3/g'`" >> $GITHUB_ENV - - name: setup test suite - run: tox run -vv --notest --skip-missing-interpreters false - - name: run test suite - run: tox run --skip-pkg-install - - check: - name: tox env ${{ matrix.tox_env }} - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - tox_env: - - type - - dev - - readme - steps: - - uses: actions/checkout@v4 - - name: setup Python 3.12 - uses: actions/setup-python@v5 - with: - python-version: "3.12" - - name: install tox - run: python -m pip install tox-uv - - name: Setup test suite - run: tox -vv --notest --skip-missing-interpreters false -e ${{ matrix.tox_env }} - - name: Run test suite - run: tox --skip-pkg-install -e ${{ matrix.tox_env }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..46415ce --- /dev/null +++ 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/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 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 55c7df6..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: Release to PyPI -on: - push: - tags: ["*"] - -jobs: - release: - runs-on: ubuntu-latest - environment: - name: release - url: https://pypi.org/p/pipdeptree - permissions: - id-token: write - steps: - - name: Setup python to build package - uses: actions/setup-python@v5 - with: - python-version: "3.12" - - name: Install build - run: python -m pip install build - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Build package - run: pyproject-build -s -w . -o dist - - name: Publish to PyPI - uses: pypa/gh-action-pypi-publish@v1.10.1 diff --git a/tox.ini b/tox.ini index ad8593c..e396d11 100644 --- a/tox.ini +++ b/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