Not ready to test on multiple OSes after all #62
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
| # There are two kinds of continuous integration jobs in this project: | |
| # | |
| # - Every code submission or master push passes continuous integration on the | |
| # minimal supported Rust version and the current stable Rust version. | |
| # - Two times a month, a scheduled job makes sure that the code remains | |
| # compatible and lint-free on upcoming Rust toolchains (beta and nightly). | |
| name: Continuous Integration | |
| on: | |
| push: | |
| pull_request: | |
| schedule: | |
| - cron: '0 0 3/15 * *' | |
| # Cancel existing jobs on new pushes to the same branch | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| env: | |
| RUSTFLAGS: -D warnings | |
| RUSTDOCFLAGS: -D warnings | |
| jobs: | |
| # Render the book | |
| render-book: | |
| # Don't run CI twice when a PR is created from a branch internal to the repo | |
| # Don't run on a schedule, book doesn't change on its own. | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Install mdbook and mdbook-katex | |
| uses: taiki-e/install-action@v2 | |
| with: | |
| tool: mdbook,mdbook-katex | |
| - name: Render the book | |
| run: (mkdir public && cd book && mdbook build -d ../public) | |
| - name: Upload the book | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: book | |
| path: ./public | |
| if-no-files-found: error | |
| # Formatter output and dependency checking don't depend on cargo features / OS | |
| format-machete: | |
| # Don't run CI twice when a PR is created from a branch internal to the repo | |
| # Don't run in scheduled jobs, that's what "scheduled" is for | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Set up Rust caching | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Install rustfmt | |
| run: rustup component add rustfmt | |
| - name: Check code formatting | |
| run: cargo fmt --all --check | |
| - name: Install cargo-machete | |
| uses: baptiste0928/cargo-install@v3 | |
| with: | |
| crate: cargo-machete | |
| - name: Look for unused dependencies with cargo-machete | |
| run: | | |
| # FIXME: --force used as a workaround for https://github.com/Swatinem/rust-cache/issues/204 | |
| cargo binstall -y --force cargo-machete | |
| cargo machete | |
| # Lints and test outcome can vary depending on hardware and benchmark features | |
| lints-tests: | |
| # Don't run CI twice when a PR is created from a branch internal to the repo | |
| # Don't run in scheduled jobs, that's what "scheduled" is for | |
| if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| target-flags: | |
| - "" | |
| - "-C target-cpu=native" | |
| features: | |
| - "--no-default-features --features=check" | |
| - "" | |
| - "--features=measure" | |
| - "--all-features" | |
| env: | |
| RUSTFLAGS: "-D warnings ${{ matrix.target-flags }}" | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Set up hwloc | |
| uses: awalsh128/cache-apt-pkgs-action@latest | |
| with: | |
| version: 1.0 | |
| packages: libhwloc-dev libudev-dev | |
| - name: Set up Rust caching | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Install clippy | |
| run: rustup component add clippy | |
| - name: Check clippy lints | |
| run: cargo clippy --workspace --all-targets ${{ matrix.features }} -- -D warnings | |
| - name: Install cargo-nextest | |
| uses: baptiste0928/cargo-install@v3 | |
| with: | |
| crate: cargo-nextest | |
| - name: Run tests | |
| run: cargo nextest --workspace ${{ matrix.features }} | |
| # Update the book if all other CI jobs pass | |
| deploy-book: | |
| # Don't run on a schedule, book doesn't change on its own. | |
| # Don't run on pull request events, they don't have permission to deploy | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: ["render-book", "format-machete", "lints-tests"] | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| pages: write # to deploy to Pages | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| steps: | |
| - name: Download the book | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: book | |
| path: . | |
| - name: Configure github pages | |
| uses: actions/configure-pages@v1 | |
| - name: Upload book to github pages | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: . | |
| - name: Deploy github pages | |
| id: deployment | |
| uses: actions/deploy-pages@v1 | |
| # Check compatibility with newer Rust and dependencies versions (scheduled CI) | |
| scheduled: | |
| if: github.event_name == 'schedule' | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| target-flags: | |
| - "" | |
| - "-C target-cpu=native" | |
| nightly-version: | |
| - "selected" | |
| - "latest" | |
| features: | |
| - "--no-default-features --features=check" | |
| - "" | |
| - "--features=measure" | |
| - "--all-features" | |
| env: | |
| RUSTFLAGS: "-D warnings ${{ matrix.target-flags }}" | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| - name: Set up hwloc | |
| uses: awalsh128/cache-apt-pkgs-action@latest | |
| with: | |
| version: 1.0 | |
| packages: libhwloc-dev libudev-dev | |
| # No caching here because the job does not run often enough | |
| - name: Switch to latest rust nightly | |
| run: echo "nightly" > rust-toolchain | |
| if: matrix.nightly-version == 'latest' | |
| - name: Install rustfmt | |
| run: rustup component add rustfmt | |
| - name: Check code formatting | |
| run: cargo fmt --all --check | |
| - name: Install clippy | |
| run: rustup component add clippy | |
| - name: Check clippy lints | |
| run: cargo clippy --workspace --all-targets ${{ matrix.features }} -- -D warnings | |
| - name: Install cargo-nextest | |
| uses: baptiste0928/cargo-install@v3 | |
| with: | |
| crate: cargo-nextest | |
| - name: Run the tests | |
| run: cargo nextest --workspace ${{ matrix.features }} | |