f5eafe23f2
* add maximum Python version check * restore dependency of `pyo3-macros-backend` on `pyo3-build-config` * fix clippy-all noxfile job
507 lines
17 KiB
YAML
507 lines
17 KiB
YAML
name: CI
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
pull_request:
|
|
merge_group:
|
|
types: [checks_requested]
|
|
workflow_dispatch:
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref_name }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
|
|
jobs:
|
|
fmt:
|
|
if: github.ref != 'refs/heads/main'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-python@v5
|
|
- run: python -m pip install --upgrade pip && pip install nox
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
with:
|
|
components: rustfmt
|
|
- name: Check python formatting and lints (ruff)
|
|
run: nox -s ruff
|
|
- name: Check rust formatting (rustfmt)
|
|
run: nox -s rustfmt
|
|
|
|
semver-checks:
|
|
if: github.ref != 'refs/heads/main'
|
|
needs: [fmt]
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-python@v5
|
|
- uses: obi1kenobi/cargo-semver-checks-action@v2
|
|
|
|
check-msrv:
|
|
needs: [fmt]
|
|
runs-on: ubuntu-latest
|
|
if: github.ref != 'refs/heads/main'
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: dtolnay/rust-toolchain@master
|
|
with:
|
|
toolchain: 1.56.0
|
|
targets: x86_64-unknown-linux-gnu
|
|
components: rust-src
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
architecture: "x64"
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
key: check-msrv-1.56.0
|
|
continue-on-error: true
|
|
- run: python -m pip install --upgrade pip && pip install nox
|
|
- name: Prepare minimal package versions
|
|
run: nox -s set-minimal-package-versions
|
|
- run: nox -s check-all
|
|
|
|
env:
|
|
CARGO_BUILD_TARGET: x86_64-unknown-linux-gnu
|
|
|
|
clippy:
|
|
needs: [fmt]
|
|
runs-on: ${{ matrix.platform.os }}
|
|
if: github.ref != 'refs/heads/main'
|
|
strategy:
|
|
# If one platform fails, allow the rest to keep testing if `CI-no-fail-fast` label is present
|
|
fail-fast: ${{ !contains(github.event.pull_request.labels.*.name, 'CI-no-fail-fast') }}
|
|
matrix:
|
|
rust: [stable]
|
|
platform: [
|
|
{
|
|
os: "macos-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-apple-darwin",
|
|
},
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
},
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "powerpc64le-unknown-linux-gnu",
|
|
},
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "s390x-unknown-linux-gnu",
|
|
},
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "wasm32-wasi",
|
|
},
|
|
{
|
|
os: "windows-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-pc-windows-msvc",
|
|
},
|
|
{
|
|
os: "windows-latest",
|
|
python-architecture: "x86",
|
|
rust-target: "i686-pc-windows-msvc",
|
|
},
|
|
]
|
|
include:
|
|
# Run beta clippy as a way to detect any incoming lints which may affect downstream users
|
|
- rust: beta
|
|
platform:
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
}
|
|
name: clippy/${{ matrix.platform.rust-target }}/${{ matrix.rust }}
|
|
continue-on-error: ${{ matrix.platform.rust != 'stable' }}
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: dtolnay/rust-toolchain@master
|
|
with:
|
|
toolchain: ${{ matrix.rust }}
|
|
targets: ${{ matrix.platform.rust-target }}
|
|
components: clippy,rust-src
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
architecture: ${{ matrix.platform.python-architecture }}
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
key: clippy-${{ matrix.platform.rust-target }}-${{ matrix.platform.os }}-${{ matrix.rust }}
|
|
continue-on-error: true
|
|
- run: python -m pip install --upgrade pip && pip install nox
|
|
- run: nox -s clippy-all
|
|
env:
|
|
CARGO_BUILD_TARGET: ${{ matrix.platform.rust-target }}
|
|
|
|
build-pr:
|
|
if: ${{ !contains(github.event.pull_request.labels.*.name, 'CI-build-full') && github.event_name == 'pull_request' }}
|
|
name: python${{ matrix.python-version }}-${{ matrix.platform.python-architecture }} ${{ matrix.platform.os }} rust-${{ matrix.rust }}
|
|
needs: [fmt]
|
|
uses: ./.github/workflows/build.yml
|
|
with:
|
|
os: ${{ matrix.platform.os }}
|
|
python-version: ${{ matrix.python-version }}
|
|
python-architecture: ${{ matrix.platform.python-architecture }}
|
|
rust: ${{ matrix.rust }}
|
|
rust-target: ${{ matrix.platform.rust-target }}
|
|
extra-features: ${{ matrix.platform.extra-features }}
|
|
secrets: inherit
|
|
strategy:
|
|
# If one platform fails, allow the rest to keep testing if `CI-no-fail-fast` label is present
|
|
fail-fast: ${{ !contains(github.event.pull_request.labels.*.name, 'CI-no-fail-fast') }}
|
|
matrix:
|
|
extra-features: ["multiple-pymethods"]
|
|
rust: [stable]
|
|
python-version: ["3.12"]
|
|
platform:
|
|
[
|
|
{
|
|
os: "macos-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-apple-darwin",
|
|
},
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
},
|
|
{
|
|
os: "windows-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-pc-windows-msvc",
|
|
},
|
|
{
|
|
os: "windows-latest",
|
|
python-architecture: "x86",
|
|
rust-target: "i686-pc-windows-msvc",
|
|
},
|
|
]
|
|
include:
|
|
# Test nightly Rust on PRs so that PR authors have a chance to fix nightly
|
|
# failures, as nightly does not block merge.
|
|
- rust: nightly
|
|
python-version: "3.12"
|
|
platform:
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
}
|
|
extra-features: "nightly multiple-pymethods"
|
|
build-full:
|
|
if: ${{ contains(github.event.pull_request.labels.*.name, 'CI-build-full') || (github.event_name != 'pull_request' && github.ref != 'refs/heads/main') }}
|
|
name: python${{ matrix.python-version }}-${{ matrix.platform.python-architecture }} ${{ matrix.platform.os }} rust-${{ matrix.rust }}
|
|
needs: [fmt]
|
|
uses: ./.github/workflows/build.yml
|
|
with:
|
|
os: ${{ matrix.platform.os }}
|
|
python-version: ${{ matrix.python-version }}
|
|
python-architecture: ${{ matrix.platform.python-architecture }}
|
|
rust: ${{ matrix.rust }}
|
|
rust-target: ${{ matrix.platform.rust-target }}
|
|
extra-features: ${{ matrix.platform.extra-features }}
|
|
secrets: inherit
|
|
strategy:
|
|
# If one platform fails, allow the rest to keep testing if `CI-no-fail-fast` label is present
|
|
fail-fast: ${{ !contains(github.event.pull_request.labels.*.name, 'CI-no-fail-fast') }}
|
|
matrix:
|
|
extra-features: ["multiple-pymethods"] # Because MSRV doesn't support this
|
|
rust: [stable]
|
|
python-version: [
|
|
"3.7",
|
|
"3.8",
|
|
"3.9",
|
|
"3.10",
|
|
"3.11",
|
|
"3.12",
|
|
"pypy3.7",
|
|
"pypy3.8",
|
|
"pypy3.9",
|
|
"pypy3.10",
|
|
]
|
|
platform:
|
|
[
|
|
{
|
|
os: "macos-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-apple-darwin",
|
|
},
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
},
|
|
{
|
|
os: "windows-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-pc-windows-msvc",
|
|
},
|
|
]
|
|
include:
|
|
# Test minimal supported Rust version
|
|
- rust: 1.56.0
|
|
python-version: "3.12"
|
|
platform:
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
}
|
|
extra-features: ""
|
|
|
|
# Test the `nightly` feature
|
|
- rust: nightly
|
|
python-version: "3.12"
|
|
platform:
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
}
|
|
extra-features: "nightly multiple-pymethods"
|
|
|
|
# Run rust beta to help catch toolchain regressions
|
|
- rust: beta
|
|
python-version: "3.12"
|
|
platform:
|
|
{
|
|
os: "ubuntu-latest",
|
|
python-architecture: "x64",
|
|
rust-target: "x86_64-unknown-linux-gnu",
|
|
}
|
|
extra-features: "multiple-pymethods"
|
|
|
|
# Test 32-bit Windows only with the latest Python version
|
|
- rust: stable
|
|
python-version: "3.12"
|
|
platform:
|
|
{
|
|
os: "windows-latest",
|
|
python-architecture: "x86",
|
|
rust-target: "i686-pc-windows-msvc",
|
|
}
|
|
extra-features: "multiple-pymethods"
|
|
|
|
valgrind:
|
|
if: ${{ contains(github.event.pull_request.labels.*.name, 'CI-build-full') || (github.event_name != 'pull_request' && github.ref != 'refs/heads/main') }}
|
|
needs: [fmt]
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-python@v5
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
key: cargo-valgrind
|
|
continue-on-error: true
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- uses: taiki-e/install-action@valgrind
|
|
- run: python -m pip install --upgrade pip && pip install nox
|
|
- run: nox -s test-rust -- release skip-full
|
|
env:
|
|
CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_RUNNER: valgrind --leak-check=no --error-exitcode=1
|
|
RUST_BACKTRACE: 1
|
|
TRYBUILD: overwrite
|
|
|
|
careful:
|
|
if: ${{ contains(github.event.pull_request.labels.*.name, 'CI-build-full') || (github.event_name != 'pull_request' && github.ref != 'refs/heads/main') }}
|
|
needs: [fmt]
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-python@v5
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
key: cargo-careful
|
|
continue-on-error: true
|
|
- uses: dtolnay/rust-toolchain@nightly
|
|
with:
|
|
components: rust-src
|
|
- uses: taiki-e/install-action@cargo-careful
|
|
- run: python -m pip install --upgrade pip && pip install nox
|
|
- run: nox -s test-rust -- careful skip-full
|
|
env:
|
|
RUST_BACKTRACE: 1
|
|
TRYBUILD: overwrite
|
|
|
|
docsrs:
|
|
if: ${{ contains(github.event.pull_request.labels.*.name, 'CI-build-full') || (github.event_name != 'pull_request' && github.ref != 'refs/heads/main') }}
|
|
needs: [fmt]
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-python@v5
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
key: cargo-careful
|
|
continue-on-error: true
|
|
- uses: dtolnay/rust-toolchain@nightly
|
|
with:
|
|
components: rust-src
|
|
- run: cargo rustdoc --lib --no-default-features --features full -Zunstable-options --config "build.rustdocflags=[\"--cfg\", \"docsrs\"]"
|
|
|
|
coverage:
|
|
needs: [fmt]
|
|
name: coverage-${{ matrix.os }}
|
|
strategy:
|
|
matrix:
|
|
os: ["windows", "macos", "ubuntu"]
|
|
runs-on: ${{ matrix.os }}-latest
|
|
steps:
|
|
- if: ${{ github.event_name == 'pull_request' && matrix.os != 'ubuntu' }}
|
|
id: should-skip
|
|
shell: bash
|
|
run: echo 'skip=true' >> $GITHUB_OUTPUT
|
|
- uses: actions/checkout@v4
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
- uses: actions/setup-python@v5
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
- uses: Swatinem/rust-cache@v2
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
with:
|
|
key: coverage-cargo-${{ matrix.os }}
|
|
continue-on-error: true
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
with:
|
|
components: llvm-tools-preview,rust-src
|
|
- name: Install cargo-llvm-cov
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
uses: taiki-e/install-action@cargo-llvm-cov
|
|
- run: python -m pip install --upgrade pip && pip install nox
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
- run: nox -s coverage
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
- uses: codecov/codecov-action@v4
|
|
if: steps.should-skip.outputs.skip != 'true'
|
|
with:
|
|
file: coverage.json
|
|
name: ${{ matrix.os }}
|
|
token: ${{ secrets.CODECOV_TOKEN }}
|
|
|
|
emscripten:
|
|
name: emscripten
|
|
if: ${{ contains(github.event.pull_request.labels.*.name, 'CI-build-full') || (github.event_name != 'pull_request' && github.ref != 'refs/heads/main') }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
# TODO bump emscripten builds to test on 3.12
|
|
python-version: 3.11
|
|
id: setup-python
|
|
- name: Install Rust toolchain
|
|
uses: dtolnay/rust-toolchain@stable
|
|
with:
|
|
targets: wasm32-unknown-emscripten
|
|
components: rust-src
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 14
|
|
- run: python -m pip install --upgrade pip && pip install nox
|
|
- uses: actions/cache@v4
|
|
id: cache
|
|
with:
|
|
path: |
|
|
.nox/emscripten
|
|
key: ${{ hashFiles('emscripten/*') }} - ${{ hashFiles('noxfile.py') }} - ${{ steps.setup-python.outputs.python-path }}
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
key: cargo-emscripten-wasm32
|
|
- name: Build
|
|
if: steps.cache.outputs.cache-hit != 'true'
|
|
run: nox -s build-emscripten
|
|
- name: Test
|
|
run: nox -s test-emscripten
|
|
|
|
test-debug:
|
|
needs: [fmt]
|
|
if: github.ref != 'refs/heads/main'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: Swatinem/rust-cache@v2
|
|
with:
|
|
key: cargo-test-debug
|
|
continue-on-error: true
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
with:
|
|
components: rust-src
|
|
- name: Install python3 standalone debug build with nox
|
|
run: |
|
|
PBS_RELEASE="20231002"
|
|
PBS_PYTHON_VERSION="3.12.0"
|
|
PBS_ARCHIVE="cpython-${PBS_PYTHON_VERSION}+${PBS_RELEASE}-x86_64-unknown-linux-gnu-debug-full.tar.zst"
|
|
wget "https://github.com/indygreg/python-build-standalone/releases/download/${PBS_RELEASE}/${PBS_ARCHIVE}"
|
|
tar -I zstd -xf "${PBS_ARCHIVE}"
|
|
ls -l $(pwd)/python/install/bin
|
|
ls -l $(pwd)/python/install/lib
|
|
echo PATH=$(pwd)/python/install/bin:$PATH >> $GITHUB_ENV
|
|
echo LD_LIBRARY_PATH=$(pwd)/python/install/lib:$LD_LIBRARY_PATH >> $GITHUB_ENV
|
|
echo PYTHONHOME=$(pwd)/python/install >> $GITHUB_ENV
|
|
echo PYO3_PYTHON=$(pwd)/python/install/bin/python3 >> $GITHUB_ENV
|
|
- run: python3 -m sysconfig
|
|
- run: python3 -m pip install --upgrade pip && pip install nox
|
|
- run: |
|
|
PYO3_CONFIG_FILE=$(mktemp)
|
|
cat > $PYO3_CONFIG_FILE << EOF
|
|
implementation=CPython
|
|
version=3.12
|
|
shared=true
|
|
abi3=false
|
|
lib_name=python3.12d
|
|
lib_dir=${{ github.workspace }}/python/install/lib
|
|
executable=${{ github.workspace }}/python/install/bin/python3
|
|
pointer_width=64
|
|
build_flags=Py_DEBUG,Py_REF_DEBUG
|
|
suppress_build_script_link_lines=false
|
|
EOF
|
|
echo PYO3_CONFIG_FILE=$PYO3_CONFIG_FILE >> $GITHUB_ENV
|
|
- run: python3 -m nox -s test
|
|
|
|
test-version-limits:
|
|
needs: [fmt]
|
|
if: ${{ contains(github.event.pull_request.labels.*.name, 'CI-build-full') || (github.event_name != 'pull_request' && github.ref != 'refs/heads/main') }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: Swatinem/rust-cache@v2
|
|
continue-on-error: true
|
|
- uses: dtolnay/rust-toolchain@stable
|
|
- run: python3 -m pip install --upgrade pip && pip install nox
|
|
- run: python3 -m nox -s test-version-limits
|
|
|
|
conclusion:
|
|
needs:
|
|
- fmt
|
|
- check-msrv
|
|
- clippy
|
|
- build-pr
|
|
- build-full
|
|
- valgrind
|
|
- careful
|
|
- docsrs
|
|
- coverage
|
|
- emscripten
|
|
- test-debug
|
|
- test-version-limits
|
|
if: always()
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Result
|
|
run: |
|
|
jq -C <<< "${needs}"
|
|
# Check if all needs were successful or skipped.
|
|
"$(jq -r 'all(.result as $result | (["success", "skipped"] | contains([$result])))' <<< "${needs}")"
|
|
env:
|
|
needs: ${{ toJson(needs) }}
|