future proof style external crate support #101
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: | |
| # Ignore bors branches, since they are covered by `clippy_bors.yml` | |
| branches: | |
| - main | |
| # Don't run Clippy tests, when only textfiles were modified | |
| paths-ignore: | |
| - 'README' | |
| - 'COPYRIGHT' | |
| - 'LICENSE-*' | |
| - '**.md' | |
| - '**.txt' | |
| pull_request: | |
| # Don't run Clippy tests, when only textfiles were modified | |
| paths-ignore: | |
| - 'README' | |
| - 'COPYRIGHT' | |
| - 'LICENSE-*' | |
| - '**.md' | |
| - '**.txt' | |
| workflow_dispatch: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| RUSTFLAGS: -Dwarnings | |
| RUST_BACKTRACE: 1 | |
| nightly: nightly | |
| jobs: | |
| # Check formatting | |
| rustfmt: | |
| name: rustfmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install Rust | |
| run: rustup update stable && rustup default stable | |
| - name: Check formatting | |
| run: rustfmt --check --edition 2021 $(git ls-files '*.rs') | |
| # This represents the minimum Rust version supported by | |
| # Bytes. Updating this should be done in a dedicated PR. | |
| # | |
| # Tests are not run as tests may require newer versions of | |
| # rust. | |
| minrust: | |
| name: minrust | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install Rust | |
| run: rustup update 1.75.0 && rustup default 1.75.0 | |
| - name: Check | |
| run: cargo check | |
| # Apply clippy lints | |
| clippy: | |
| name: clippy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Apply clippy lints | |
| run: cargo clippy --all-features | |
| unit-tests: | |
| name: unit tests | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| rust: | |
| - nightly | |
| os: | |
| - macos-latest | |
| - windows-latest | |
| - ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Install latest nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: ${{ matrix.rust }} | |
| override: true | |
| components: rustfmt, clippy | |
| - uses: Swatinem/rust-cache@v1 | |
| - uses: actions/cache@v2 | |
| with: | |
| path: | | |
| ~/.cargo/registry | |
| ~/.cargo/git | |
| target | |
| key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} | |
| - name: test all features | |
| # Run sequentially to avoid race condition around file system size | |
| run: cargo test --all-features -- --test-threads 1 | |
| docs: | |
| name: docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Cache cargo build and registry | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cargo/registry | |
| ~/.cargo/git | |
| target | |
| key: ubuntu-latest-docs-${{ hashFiles('**/Cargo.lock') }} | |
| restore-keys: | | |
| ubuntu-latest-docs- | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: ${{ env.nightly }} | |
| override: true | |
| - name: "doc --lib --all-features" | |
| run: cargo doc --lib --no-deps --all-features | |
| env: | |
| RUSTFLAGS: --cfg docsrs | |
| RUSTDOCFLAGS: --cfg docsrs -Dwarnings | |
| coverage: | |
| name: cargo tarpaulin | |
| runs-on: ubuntu-latest | |
| needs: | |
| - unit-tests | |
| - clippy | |
| - rustfmt | |
| - minrust | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install latest nightly | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: nightly | |
| override: true | |
| - uses: actions-rs/install@v0.1 | |
| with: | |
| crate: cargo-tarpaulin | |
| version: latest | |
| - name: Cache ~/.cargo | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cargo | |
| key: ${{ runner.os }}-coverage-dotcargo | |
| - name: Cache cargo build | |
| uses: actions/cache@v3 | |
| with: | |
| path: target | |
| key: ${{ runner.os }}-coverage-cargo-build-target | |
| - name: Run tarpaulin | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: tarpaulin | |
| args: --all-features --run-types tests --run-types doctests --workspace --out xml | |
| - name: Upload to codecov.io | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: true | |
| slug: al8n/fs4-rs |