mirror of
https://github.com/python-kasa/python-kasa.git
synced 2025-10-13 19:08:02 +00:00
Speed up and simplify github workflows (#1128)
- Enable parallel tests in the CI with pytest-xdist - Migrate to the official `astral-sh/setup-uv` github action - Call `pre-commit` run as a single job in CI instead of relisting each check - Use `uv` version 0.4.16 - Fix bug with pre-commit cache - Update `publish.yml` to use `astral-sh/setup-uv`
This commit is contained in:
61
.github/actions/setup/action.yaml
vendored
61
.github/actions/setup/action.yaml
vendored
@@ -1,12 +1,12 @@
|
||||
---
|
||||
name: Setup Environment
|
||||
description: Install requested pipx dependencies, configure the system python, and install uv and the package dependencies
|
||||
description: Install uv, configure the system python, and the package dependencies
|
||||
|
||||
inputs:
|
||||
uv-install-options:
|
||||
default: ""
|
||||
uv-version:
|
||||
default: 0.4.5
|
||||
default: 0.4.16
|
||||
python-version:
|
||||
required: true
|
||||
cache-pre-commit:
|
||||
@@ -17,66 +17,29 @@ inputs:
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- uses: "actions/setup-python@v5"
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v3
|
||||
with:
|
||||
enable-cache: true
|
||||
|
||||
- name: "Setup python"
|
||||
uses: "actions/setup-python@v5"
|
||||
id: setup-python
|
||||
with:
|
||||
python-version: "${{ inputs.python-version }}"
|
||||
allow-prereleases: true
|
||||
|
||||
- name: Setup pipx environment Variables
|
||||
id: pipx-env-setup
|
||||
# pipx default home and bin dir are not writable by the cache action
|
||||
# so override them here and add the bin dir to PATH for later steps.
|
||||
# This also ensures the pipx cache only contains uv
|
||||
run: |
|
||||
SEP="${{ !startsWith(runner.os, 'windows') && '/' || '\\' }}"
|
||||
PIPX_CACHE="${{ github.workspace }}${SEP}pipx_cache"
|
||||
echo "pipx-cache-path=${PIPX_CACHE}" >> $GITHUB_OUTPUT
|
||||
echo "pipx-version=$(pipx --version)" >> $GITHUB_OUTPUT
|
||||
echo "PIPX_HOME=${PIPX_CACHE}${SEP}home" >> $GITHUB_ENV
|
||||
echo "PIPX_BIN_DIR=${PIPX_CACHE}${SEP}bin" >> $GITHUB_ENV
|
||||
echo "PIPX_MAN_DIR=${PIPX_CACHE}${SEP}man" >> $GITHUB_ENV
|
||||
echo "${PIPX_CACHE}${SEP}bin" >> $GITHUB_PATH
|
||||
shell: bash
|
||||
|
||||
- name: Pipx cache
|
||||
id: pipx-cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ${{ steps.pipx-env-setup.outputs.pipx-cache-path }}
|
||||
key: cache-${{ inputs.cache-version }}-${{ runner.os }}-${{ runner.arch }}-python-${{ inputs.python-version }}-${{ steps.setup-python.outputs.python-version }}-pipx-${{ steps.pipx-env-setup.outputs.pipx-version }}-uv-${{ inputs.uv-version }}
|
||||
|
||||
- name: Install uv
|
||||
if: steps.pipx-cache.outputs.cache-hit != 'true'
|
||||
id: install-uv
|
||||
shell: bash
|
||||
run: |-
|
||||
pipx install uv==${{ inputs.uv-version }} --python "${{ steps.setup-python.outputs.python-path }}"
|
||||
|
||||
- name: Read uv cache location
|
||||
id: uv-cache-location
|
||||
shell: bash
|
||||
run: |-
|
||||
echo "uv-cache-location=$(uv cache dir)" >> $GITHUB_OUTPUT
|
||||
|
||||
- uses: actions/cache@v4
|
||||
name: uv cache
|
||||
with:
|
||||
path: |
|
||||
${{ steps.uv-cache-location.outputs.uv-cache-location }}
|
||||
key: cache-${{ inputs.cache-version }}-${{ runner.os }}-${{ runner.arch }}-python-${{ steps.setup-python.outputs.python-version }}-uv-${{ inputs.uv-version }}-${{ hashFiles('uv.lock') }}-options-${{ inputs.uv-install-options }}
|
||||
|
||||
- name: "uv install"
|
||||
- name: "Install project"
|
||||
shell: bash
|
||||
run: |
|
||||
uv sync --python "${{ steps.setup-python.outputs.python-path }}" ${{ inputs.uv-install-options }}
|
||||
uv sync ${{ inputs.uv-install-options }}
|
||||
|
||||
- name: Read pre-commit version
|
||||
if: inputs.cache-pre-commit == 'true'
|
||||
id: pre-commit-version
|
||||
shell: bash
|
||||
run: >-
|
||||
echo "pre-commit-version=$(uv run pre-commit -- -V | awk '{print $2}')" >> $GITHUB_OUTPUT
|
||||
echo "pre-commit-version=$(uv run pre-commit -V | awk '{print $2}')" >> $GITHUB_OUTPUT
|
||||
|
||||
- uses: actions/cache@v4
|
||||
if: inputs.cache-pre-commit == 'true'
|
||||
|
43
.github/workflows/ci.yml
vendored
43
.github/workflows/ci.yml
vendored
@@ -8,7 +8,7 @@ on:
|
||||
workflow_dispatch: # to allow manual re-runs
|
||||
|
||||
env:
|
||||
UV_VERSION: 0.4.5
|
||||
UV_VERSION: 0.4.16
|
||||
|
||||
jobs:
|
||||
linting:
|
||||
@@ -20,7 +20,8 @@ jobs:
|
||||
python-version: ["3.12"]
|
||||
|
||||
steps:
|
||||
- uses: "actions/checkout@v4"
|
||||
- name: "Checkout source files"
|
||||
uses: "actions/checkout@v4"
|
||||
- name: Setup environment
|
||||
uses: ./.github/actions/setup
|
||||
with:
|
||||
@@ -28,31 +29,10 @@ jobs:
|
||||
cache-pre-commit: true
|
||||
uv-version: ${{ env.UV_VERSION }}
|
||||
uv-install-options: "--all-extras"
|
||||
- name: "Check supported device md files are up to date"
|
||||
|
||||
- name: "Run pre-commit checks"
|
||||
run: |
|
||||
uv run pre-commit run generate-supported --all-files
|
||||
- name: "Linting and code formating (ruff)"
|
||||
run: |
|
||||
uv run pre-commit run ruff --all-files
|
||||
- name: "Typing checks (mypy)"
|
||||
run: |
|
||||
source .venv/bin/activate
|
||||
pre-commit run mypy --all-files
|
||||
- name: "Run trailing-whitespace"
|
||||
run: |
|
||||
uv run pre-commit run trailing-whitespace --all-files
|
||||
- name: "Run end-of-file-fixer"
|
||||
run: |
|
||||
uv run pre-commit run end-of-file-fixer --all-files
|
||||
- name: "Run check-docstring-first"
|
||||
run: |
|
||||
uv run pre-commit run check-docstring-first --all-files
|
||||
- name: "Run debug-statements"
|
||||
run: |
|
||||
uv run pre-commit run debug-statements --all-files
|
||||
- name: "Run check-ast"
|
||||
run: |
|
||||
uv run pre-commit run check-ast --all-files
|
||||
uv run pre-commit run --all-files --verbose
|
||||
|
||||
|
||||
tests:
|
||||
@@ -83,6 +63,13 @@ jobs:
|
||||
- os: ubuntu-latest
|
||||
python-version: "3.10"
|
||||
extras: true
|
||||
# Exclude pypy on windows due to significant performance issues
|
||||
# running pytest requires ~12 min instead of 2 min on other platforms
|
||||
- os: windows-latest
|
||||
python-version: "pypy-3.9"
|
||||
- os: windows-latest
|
||||
python-version: "pypy-3.10"
|
||||
|
||||
|
||||
steps:
|
||||
- uses: "actions/checkout@v4"
|
||||
@@ -95,11 +82,11 @@ jobs:
|
||||
- name: "Run tests (no coverage)"
|
||||
if: ${{ startsWith(matrix.python-version, 'pypy') }}
|
||||
run: |
|
||||
uv run pytest
|
||||
uv run pytest -n auto
|
||||
- name: "Run tests (with coverage)"
|
||||
if: ${{ !startsWith(matrix.python-version, 'pypy') }}
|
||||
run: |
|
||||
uv run pytest --cov kasa --cov-report xml
|
||||
uv run pytest -n auto --cov kasa --cov-report xml
|
||||
- name: "Upload coverage to Codecov"
|
||||
if: ${{ !startsWith(matrix.python-version, 'pypy') }}
|
||||
uses: "codecov/codecov-action@v4"
|
||||
|
16
.github/workflows/publish.yml
vendored
16
.github/workflows/publish.yml
vendored
@@ -4,7 +4,8 @@ on:
|
||||
types: [published]
|
||||
|
||||
env:
|
||||
UV_VERSION: 0.4.5
|
||||
UV_VERSION: 0.4.16
|
||||
PYTHON_VERSION: 3.12
|
||||
|
||||
jobs:
|
||||
build-n-publish:
|
||||
@@ -14,16 +15,19 @@ jobs:
|
||||
id-token: write
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- name: Checkout source files
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v3
|
||||
|
||||
- name: Setup python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: "3.x"
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- name: Install uv
|
||||
run: |-
|
||||
pipx install uv==${{ env.UV_VERSION }} --python "${{ steps.setup-python.outputs.python-path }}"
|
||||
- name: Build a binary wheel and a source tarball
|
||||
run: uv build
|
||||
|
||||
- name: Publish release on pypi
|
||||
uses: pypa/gh-action-pypi-publish@release/v1
|
||||
|
Reference in New Issue
Block a user