run cargo doc check on CI
#391
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 | |
| on: [push, pull_request] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| unit-test: | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| fail-fast: true | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: Run tests on Linux or macOS | |
| run: | | |
| cargo llvm-cov --color always --lcov --output-path lcov.info --features=search,termwiz,termion,arbitrary | |
| cargo llvm-cov --color always --no-run | |
| if: ${{ matrix.os != 'windows-latest' }} | |
| - name: Run tests on Windows | |
| run: | | |
| cargo llvm-cov --color always --lcov --output-path lcov.info --features=search,termwiz,arbitrary | |
| cargo llvm-cov --color always --no-run | |
| if: ${{ matrix.os == 'windows-latest' }} | |
| - run: cargo test --no-default-features --features=tuirs-crossterm,search -- --skip .rs | |
| - run: cargo test --no-default-features --features=tuirs-termion,search -- --skip .rs | |
| if: ${{ matrix.os != 'windows-latest' }} | |
| - run: cargo test --no-default-features --features=no-backend,search -- --skip .rs | |
| - run: cargo test --no-default-features --features=tuirs-no-backend,search -- --skip .rs | |
| - uses: codecov/codecov-action@v3 | |
| with: | |
| files: lcov.info | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: clippy,rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| - run: cargo fmt -- --check | |
| - run: cargo clippy --examples --tests -- -D warnings | |
| - run: cargo clippy --examples --tests --features search -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features termion -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features termion,search -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features termwiz -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features termwiz,search -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features no-backend -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features no-backend,search -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features tuirs-crossterm -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features tuirs-crossterm,search -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features tuirs-termion -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features tuirs-termion,search -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features tuirs-no-backend -- -D warnings | |
| - run: cargo clippy --examples --tests --no-default-features --features tuirs-no-backend,search -- -D warnings | |
| - run: cargo rustdoc --features=search,termwiz,termion -p tui-textarea -- -D warnings | |
| cargo-doc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@nightly | |
| - name: Run `cargo doc` with same configuration as docs.rs | |
| run: | | |
| set -e | |
| md="$(cargo metadata --format-version=1 | jq '.packages[] | select(.name=="wry") | .metadata.docs.rs')" | |
| export RUSTDOCFLAGS="$(echo "$md" | jq -r '.["rustdoc-args"] | join(" ")')" | |
| features="$(echo "$md" | jq -r '.features | join(",")')" | |
| no_default_features= | |
| if [ "$(echo "$md" | jq '.["no-default-features"]')" = true ]; then | |
| no_default_features="--no-default-features" | |
| fi | |
| set -x | |
| for target in $(echo "$md" | jq -r '.targets | join(" ")') | |
| do | |
| rustup target add "$target" | |
| cargo doc "$no_default_features" "--features=$features" "--target=$target" | |
| done |