Add some docs #677
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
| name: CI | |
| env: | |
| CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| find-msrv: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| version: ${{ steps.step2.outputs.version }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - id: step2 | |
| run: echo "version=`cat Cargo.toml | sed -n 's/rust-version = "\(.*\)"/\1/p'`" >> "$GITHUB_OUTPUT" | |
| benchmarks: | |
| runs-on: ubuntu-latest | |
| needs: [clippy,no-unused-dependencies] | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Cache cargo home | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-cargo-home | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| ~/.cargo/registry/index | |
| ~/.cargo/registry/cache | |
| ~/.cargo/git/db | |
| key: ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}- | |
| - name: Compile benchmarks (1k) | |
| run: cargo bench --no-run --bench event_parsing | |
| - name: Compile benchmarks (100k) | |
| run: cargo bench --no-run --bench event_parsing_100k | |
| clippy: | |
| runs-on: ubuntu-latest | |
| needs: [rustfmt,no-unused-dependencies,wasm-compatible-common-crate] | |
| name: nightly Clippy | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Cache cargo home | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-cargo-home | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| ~/.cargo/registry/index | |
| ~/.cargo/registry/cache | |
| ~/.cargo/git/db | |
| key: ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}- | |
| - name: Install nightly | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| components: clippy | |
| toolchain: nightly | |
| - name: Clippy | |
| run: cargo clippy --tests --workspace --no-deps -- -D warnings | |
| tests: | |
| runs-on: ubuntu-latest | |
| needs: [clippy,no-unused-dependencies] | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Cache cargo home | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-cargo-home | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| ~/.cargo/registry/index | |
| ~/.cargo/registry/cache | |
| ~/.cargo/git/db | |
| key: ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}- | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| - name: Install Dependencies | |
| run: | | |
| sudo apt -y install at-spi2-core systemd | |
| - name: Run Tests (tokio) | |
| run: cargo test --workspace --no-default-features --features=tokio -- --nocapture | |
| - name: Run Tests (async-std) | |
| run: cargo test --workspace --no-default-features --features=async-std -- --nocapture | |
| rustfmt: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| components: rustfmt | |
| - name: Run formatter | |
| run: cargo fmt --all --check | |
| rustdoc: | |
| runs-on: ubuntu-latest | |
| needs: [clippy,no-unused-dependencies] | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Cache cargo home | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-cargo-home | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| ~/.cargo/registry/index | |
| ~/.cargo/registry/cache | |
| ~/.cargo/git/db | |
| key: ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}- | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly | |
| - name: Generate Documentation | |
| run: cargo doc --workspace --no-deps --document-private-items | |
| no-unused-dependencies: | |
| runs-on: ubuntu-latest | |
| needs: [rustfmt] | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Cache cargo home | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-cargo-home | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| ~/.cargo/registry/index | |
| ~/.cargo/registry/cache | |
| ~/.cargo/git/db | |
| key: ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}- | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| - name: Install Cargo Machete | |
| uses: taiki-e/install-action@cargo-machete | |
| - name: Check For Unused Dependencies | |
| run: cargo machete | |
| semver-compliance: | |
| runs-on: ubuntu-latest | |
| needs: [clippy,no-unused-dependencies] | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Cache cargo home | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-cargo-home | |
| with: | |
| path: | | |
| ~/.cargo/bin | |
| ~/.cargo/registry/index | |
| ~/.cargo/registry/cache | |
| ~/.cargo/git/db | |
| key: ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}-${{ hashFiles('Cargo.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-x86_64-unknown-linux-gnu-build-${{ env.cache-name }}- | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| - name: Install Semver Checks | |
| # no default features so that it uses native Rust TLS instead of trying to link with system TLS. | |
| uses: taiki-e/install-action@main | |
| with: | |
| tool: cargo-semver-checks | |
| - name: Check Semver Compliance | |
| run: cargo semver-checks check-release -p atspi --default-features | |
| msrv-compliance: | |
| runs-on: ubuntu-latest | |
| needs: [clippy,no-unused-dependencies,find-msrv] | |
| steps: | |
| - name: install stable toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ needs.find-msrv.outputs.version }} | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Check MSRV Compliance | |
| run: cargo test --workspace --no-run --all-features | |
| wasm-compatible-common-crate: | |
| runs-on: ubuntu-latest | |
| needs: [rustfmt] | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| - name: Install WASM target(s) | |
| run: rustup target add wasm32-wasi && rustup target add wasm32-unknown-unknown | |
| - name: Test Common Compilation (wasm32-unknown-unknown) | |
| working-directory: atspi-common | |
| run: cargo build --no-default-features --target wasm32-unknown-unknown | |
| - name: Test Common Compilation (wasm32-wasi) | |
| working-directory: atspi-common | |
| run: cargo build --no-default-features --target wasm32-wasi | |
| coverage: | |
| runs-on: ubuntu-latest | |
| needs: [clippy,no-unused-dependencies] | |
| steps: | |
| - name: Git checkout | |
| uses: actions/checkout@v3 | |
| - name: Install nightly | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: stable | |
| components: llvm-tools-preview | |
| - name: cargo install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: cargo generate-lockfile | |
| if: hashFiles('Cargo.lock') == '' | |
| run: cargo generate-lockfile | |
| - name: Install Dependencies | |
| run: | | |
| sudo apt -y install at-spi2-core systemd | |
| - name: cargo llvm-cov | |
| run: cargo llvm-cov --workspace --locked --lcov --output-path lcov.info | |
| - name: Upload to codecov.io | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} |