Update README.md #38
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
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| name: check | |
| jobs: | |
| fmt: | |
| runs-on: ubuntu-latest | |
| name: stable / fmt | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install stable | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt | |
| - name: cargo fmt --check | |
| run: cargo fmt --check | |
| clippy: | |
| runs-on: ubuntu-latest | |
| name: ${{ matrix.toolchain }} / clippy | |
| permissions: | |
| contents: read | |
| checks: write | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| # Get early warning of new lints which are regularly introduced in beta channels. | |
| toolchain: [stable, beta] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install ${{ matrix.toolchain }} | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| components: clippy | |
| - name: cargo clippy | |
| uses: actions-rs/clippy-check@v1 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| doc: | |
| # run docs generation on nightly rather than stable. This enables features like | |
| # https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html which allows an | |
| # API be documented as only available in some specific platforms. | |
| runs-on: ubuntu-latest | |
| name: nightly / doc | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install nightly | |
| uses: dtolnay/rust-toolchain@nightly | |
| - name: cargo doc | |
| run: cargo doc --no-deps --all-features | |
| env: | |
| RUSTDOCFLAGS: --cfg docsrs | |
| hack: | |
| # cargo-hack checks combinations of feature flags to ensure that features are all additive | |
| # which is required for feature unification | |
| runs-on: ubuntu-latest | |
| name: ubuntu / stable / features | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install stable | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: cargo install cargo-hack | |
| uses: taiki-e/install-action@cargo-hack | |
| # intentionally no target specifier; see https://github.com/jonhoo/rust-ci-conf/pull/4 | |
| # --feature-powerset runs for every combination of features | |
| - name: cargo hack | |
| run: cargo hack --feature-powerset check | |
| # TODO: Work for msrv | |
| # msrv: | |
| # # check that we can build using the minimal rust version that is specified by this crate | |
| # runs-on: ubuntu-latest | |
| # # we use a matrix here just because env can't be used in job names | |
| # # https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability | |
| # strategy: | |
| # matrix: | |
| # msrv: ["1.56.1"] # 2021 edition requires 1.56 | |
| # name: ubuntu / ${{ matrix.msrv }} | |
| # steps: | |
| # - uses: actions/checkout@v4 | |
| # with: | |
| # submodules: true | |
| # - name: Install ${{ matrix.msrv }} | |
| # uses: dtolnay/rust-toolchain@master | |
| # with: | |
| # toolchain: ${{ matrix.msrv }} | |
| # - name: cargo +${{ matrix.msrv }} check | |
| # run: cargo check | |