Update to the latest Linebender CI standard. #1593
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| env: | |
| # We aim to always test with the latest stable Rust toolchain, however we pin to a specific | |
| # version like 1.70. Note that we only specify MAJOR.MINOR and not PATCH so that bugfixes still | |
| # come automatically. If the version specified here is no longer the latest stable version, | |
| # then please feel free to submit a PR that adjusts it along with the potential clippy fixes. | |
| RUST_STABLE_VER: "1.82" # In quotes because otherwise (e.g.) 1.70 would be interpreted as 1.7 | |
| # The purpose of checking with the minimum supported Rust toolchain is to detect its staleness. | |
| # If the compilation fails, then the version specified here needs to be bumped up to reality. | |
| # Be sure to also update the rust-version property in the workspace Cargo.toml file, | |
| # plus all the README.md files of the affected packages. | |
| RUST_MIN_VER: "1.82" | |
| # List of packages that will be checked with the minimum supported Rust version. | |
| # This should be limited to packages that are intended for publishing. | |
| RUST_MIN_VER_PKGS: "-p piet -p piet-common -p piet-cairo -p piet-coregraphics -p piet-direct2d -p piet-svg -p piet-web" | |
| # List of packages that can not target Wasm. | |
| NO_WASM_PKGS: "--exclude piet-cairo --exclude piet-coregraphics --exclude piet-direct2d --exclude piet-svg" | |
| # List of packages that can not target Windows. | |
| NO_WINDOWS_PKGS: "--exclude piet-cairo --exclude piet-coregraphics --exclude piet-web" | |
| # List of packages that can not target macOS. | |
| NO_MACOS_PKGS: "--exclude piet-cairo --exclude piet-direct2d --exclude piet-web" | |
| # List of packages that can not target Ubuntu. | |
| NO_UBUNTU_PKGS: "--exclude piet-coregraphics --exclude piet-direct2d --exclude piet-web" | |
| # Rationale | |
| # | |
| # We don't run clippy with --all-targets because then even --lib and --bins are compiled with | |
| # dev dependencies enabled, which does not match how they would be compiled by users. | |
| # A dev dependency might enable a feature that we need for a regular dependency, | |
| # and checking with --all-targets would not find our feature requirements lacking. | |
| # This problem still applies to cargo resolver version 2. | |
| # Thus we split all the targets into two steps, one with --lib --bins | |
| # and another with --tests --benches --examples. | |
| # Also, we can't give --lib --bins explicitly because then cargo will error on binary-only packages. | |
| # Luckily the default behavior of cargo with no explicit targets is the same but without the error. | |
| # | |
| # We use cargo-hack for a similar reason. Cargo's --workspace will do feature unification across | |
| # the whole workspace. While cargo-hack will instead check each workspace package separately. | |
| # | |
| # Using cargo-hack also allows us to more easily test the feature matrix of our packages. | |
| # We use --each-feature & --optional-deps which will run a separate check for every feature. | |
| # | |
| # The MSRV jobs run only cargo check because different clippy versions can disagree on goals and | |
| # running tests introduces dev dependencies which may require a higher MSRV than the bare package. | |
| # | |
| # We don't save caches in the merge-group cases, because those caches will never be re-used (apart | |
| # from the very rare cases where there are multiple PRs in the merge queue). | |
| # This is because GitHub doesn't share caches between merge queues and the main branch. | |
| name: CI | |
| on: | |
| pull_request: | |
| merge_group: | |
| # We run on push, even though the commit is the same as when we ran in merge_group. | |
| # This allows the cache to be primed. | |
| # See https://github.com/orgs/community/discussions/66430 | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| fmt: | |
| name: formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install stable toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_STABLE_VER }} | |
| components: rustfmt | |
| - name: cargo fmt | |
| run: cargo fmt --all --check | |
| - name: install ripgrep | |
| run: | | |
| sudo apt update | |
| sudo apt install ripgrep | |
| - name: check copyright headers | |
| run: bash .github/copyright.sh | |
| clippy-stable: | |
| name: cargo clippy | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [windows-latest, macos-latest, ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install stable toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_STABLE_VER }} | |
| components: clippy | |
| - name: install cargo-hack | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: cargo-hack | |
| - name: install native dependencies | |
| if: matrix.os == 'ubuntu-latest' | |
| run: sudo apt-get update; sudo apt-get install libgtk-3-dev | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| - name: cargo clippy (windows) | |
| run: cargo hack clippy --workspace ${{ env.NO_WINDOWS_PKGS }} --locked --optional-deps --each-feature -- -D warnings | |
| if: contains(matrix.os, 'windows') | |
| - name: cargo clippy (auxiliary) (windows) | |
| run: cargo hack clippy --workspace ${{ env.NO_WINDOWS_PKGS }} --locked --optional-deps --each-feature --tests --benches --examples -- -D warnings | |
| if: contains(matrix.os, 'windows') | |
| - name: cargo clippy (macos) | |
| run: cargo hack clippy --workspace ${{ env.NO_MACOS_PKGS }} --locked --optional-deps --each-feature -- -D warnings | |
| if: contains(matrix.os, 'macos') | |
| - name: cargo clippy (auxiliary) (macos) | |
| run: cargo hack clippy --workspace ${{ env.NO_MACOS_PKGS }} --locked --optional-deps --each-feature --tests --benches --examples -- -D warnings | |
| if: contains(matrix.os, 'macos') | |
| - name: cargo clippy (ubuntu) | |
| run: cargo hack clippy --workspace ${{ env.NO_UBUNTU_PKGS }} --locked --optional-deps --each-feature -- -D warnings | |
| if: contains(matrix.os, 'ubuntu') | |
| - name: cargo clippy (auxiliary) (ubuntu) | |
| run: cargo hack clippy --workspace ${{ env.NO_UBUNTU_PKGS }} --locked --optional-deps --each-feature --tests --benches --examples -- -D warnings | |
| if: contains(matrix.os, 'ubuntu') | |
| clippy-stable-wasm: | |
| name: cargo clippy (wasm32) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install stable toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_STABLE_VER }} | |
| targets: wasm32-unknown-unknown | |
| components: clippy | |
| - name: install cargo-hack | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: cargo-hack | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| - name: cargo clippy | |
| run: cargo hack clippy --workspace ${{ env.NO_WASM_PKGS }} --locked --target wasm32-unknown-unknown --optional-deps --each-feature -- -D warnings | |
| - name: cargo clippy (auxiliary) | |
| run: cargo hack clippy --workspace ${{ env.NO_WASM_PKGS }} --locked --target wasm32-unknown-unknown --optional-deps --each-feature --tests --benches --examples -- -D warnings | |
| test-stable: | |
| name: cargo test | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [windows-latest, macos-latest, ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install stable toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_STABLE_VER }} | |
| - name: install native dependencies | |
| if: matrix.os == 'ubuntu-latest' | |
| run: sudo apt-get update; sudo apt-get install libgtk-3-dev | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| - name: cargo test (windows) | |
| run: cargo test --workspace ${{ env.NO_WINDOWS_PKGS }} --locked --all-features | |
| if: contains(matrix.os, 'windows') | |
| - name: cargo test (macos) | |
| run: cargo test --workspace ${{ env.NO_MACOS_PKGS }} --locked --all-features | |
| if: contains(matrix.os, 'macos') | |
| - name: cargo test (ubuntu) | |
| run: cargo test --workspace ${{ env.NO_UBUNTU_PKGS }} --locked --all-features | |
| if: contains(matrix.os, 'ubuntu') | |
| test-stable-wasm: | |
| name: cargo test (wasm32) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install stable toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_STABLE_VER }} | |
| targets: wasm32-unknown-unknown | |
| - name: install wasm-pack | |
| run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| # TODO: Find a way to make tests work. Until then the tests are merely compiled. | |
| - name: cargo test compile | |
| run: cargo test --workspace ${{ env.NO_WASM_PKGS }} --locked --target wasm32-unknown-unknown --all-features --no-run | |
| - name: test chrome | |
| run: wasm-pack test --headless --chrome piet-common | |
| - name: test firefox | |
| run: wasm-pack test --headless --firefox piet-common | |
| check-msrv: | |
| name: cargo check (msrv) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [windows-latest, macos-latest, ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install msrv toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_MIN_VER }} | |
| - name: install cargo-hack | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: cargo-hack | |
| - name: install native dependencies | |
| if: matrix.os == 'ubuntu-latest' | |
| run: sudo apt-get update; sudo apt-get install libgtk-3-dev | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| - name: cargo check (windows) | |
| run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_WINDOWS_PKGS }} --locked --optional-deps --each-feature | |
| if: contains(matrix.os, 'windows') | |
| - name: cargo check (macos) | |
| run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_MACOS_PKGS }} --locked --optional-deps --each-feature | |
| if: contains(matrix.os, 'macos') | |
| - name: cargo check (ubuntu) | |
| run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_UBUNTU_PKGS }} --locked --optional-deps --each-feature | |
| if: contains(matrix.os, 'ubuntu') | |
| check-msrv-wasm: | |
| name: cargo check (msrv) (wasm32) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install msrv toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_MIN_VER }} | |
| targets: wasm32-unknown-unknown | |
| - name: install cargo-hack | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: cargo-hack | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| - name: cargo check | |
| run: cargo hack check ${{ env.RUST_MIN_VER_PKGS }} ${{ env.NO_WASM_PKGS }} --locked --target wasm32-unknown-unknown --optional-deps --each-feature | |
| doc: | |
| name: cargo doc | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [windows-latest, macos-latest, ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: install nightly toolchain | |
| uses: dtolnay/rust-toolchain@nightly | |
| - name: install native dependencies | |
| if: matrix.os == 'ubuntu-latest' | |
| run: sudo apt-get update; sudo apt-get install libgtk-3-dev | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| # We test documentation using nightly to match docs.rs. This prevents potential breakages | |
| - name: cargo doc (windows) | |
| run: cargo doc --workspace ${{ env.NO_WINDOWS_PKGS }} --locked --all-features --no-deps --document-private-items -Zunstable-options -Zrustdoc-scrape-examples | |
| if: contains(matrix.os, 'windows') | |
| - name: cargo doc (macos) | |
| run: cargo doc --workspace ${{ env.NO_MACOS_PKGS }} --locked --all-features --no-deps --document-private-items -Zunstable-options -Zrustdoc-scrape-examples | |
| if: contains(matrix.os, 'macos') | |
| - name: cargo doc (ubuntu) | |
| run: cargo doc --workspace ${{ env.NO_UBUNTU_PKGS }} --locked --all-features --no-deps --document-private-items -Zunstable-options -Zrustdoc-scrape-examples | |
| if: contains(matrix.os, 'ubuntu') | |
| - name: cargo doc (wasm32) | |
| run: cargo doc --workspace ${{ env.NO_WASM_PKGS }} --locked --all-features --no-deps --document-private-items -Zunstable-options -Zrustdoc-scrape-examples --target wasm32-unknown-unknown | |
| if: contains(matrix.os, 'ubuntu') | |
| # If this fails, consider changing your text or adding something to .typos.toml | |
| typos: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: check typos | |
| uses: crate-ci/[email protected] | |
| compare-snapshots: | |
| name: compare snapshots | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [windows-latest, macos-latest, ubuntu-latest] | |
| steps: | |
| - name: checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: 'true' | |
| - name: install native dependencies | |
| if: matrix.os == 'ubuntu-latest' | |
| run: sudo apt-get update; sudo apt-get install libgtk-3-dev | |
| - name: install stable toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ env.RUST_STABLE_VER }} | |
| - name: restore cache | |
| uses: Swatinem/rust-cache@v2 | |
| with: | |
| save-if: ${{ github.event_name != 'merge_group' }} | |
| # The use of always() allows for multiple scale factor steps to always run even if one of them fails. | |
| - name: generate and compare (1.00) (ubuntu+cairo) | |
| run: cargo run --manifest-path=piet-cairo/Cargo.toml --example=test-picture -- --all --scale=1 --out=cairo_samples --compare=./piet/snapshots/cairo | |
| if: contains(matrix.os, 'ubuntu') && always() | |
| - name: generate and compare (2.00) (ubuntu+cairo) | |
| run: cargo run --manifest-path=piet-cairo/Cargo.toml --example=test-picture -- --all --scale=2 --out=cairo_samples --compare=./piet/snapshots/cairo | |
| if: contains(matrix.os, 'ubuntu') && always() | |
| - name: upload failures (ubuntu+cairo) | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: cairo-failure | |
| path: cairo_samples | |
| if: contains(matrix.os, 'ubuntu') && failure() | |
| - name: generate and compare (1.00) (macos) | |
| run: cargo run --manifest-path=piet-coregraphics/Cargo.toml --example=test-picture -- --all --scale=1 --out=coregraphics_samples --compare=./piet/snapshots/coregraphics | |
| if: contains(matrix.os, 'macos') && always() | |
| - name: generate and compare (2.00) (macos) | |
| run: cargo run --manifest-path=piet-coregraphics/Cargo.toml --example=test-picture -- --all --scale=2 --out=coregraphics_samples --compare=./piet/snapshots/coregraphics | |
| if: contains(matrix.os, 'macos') && always() | |
| - name: upload failures (macos) | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coregraphics-failure | |
| path: coregraphics_samples | |
| if: contains(matrix.os, 'macos') && failure() | |
| - name: generate and compare (1.00) (d2d) | |
| run: cargo run --manifest-path=piet-direct2d/Cargo.toml --example=test-picture -- --all --scale=1 --out=d2d_samples --compare=./piet/snapshots/d2d | |
| if: contains(matrix.os, 'windows') && always() | |
| - name: generate and compare (2.00) (d2d) | |
| run: cargo run --manifest-path=piet-direct2d/Cargo.toml --example=test-picture -- --all --scale=2 --out=d2d_samples --compare=./piet/snapshots/d2d | |
| if: contains(matrix.os, 'windows') && always() | |
| - name: upload failures (d2d) | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: d2d-failure | |
| path: d2d_samples | |
| if: contains(matrix.os, 'windows') && failure() |