Skip to content

Commit 144c03c

Browse files
authored
Fix docs build (#16)
* Fix doc-cfg flag for docsrs * Bump dev dependencies * Rename std feature to kat * Remove `fn main` from doctests * Add a nudge in the docs for how many bytes to ratchet by * Temporarily use Rust v1.91.1 for CI to avoid buggy lint
1 parent dcd4053 commit 144c03c

9 files changed

Lines changed: 128 additions & 135 deletions

File tree

.github/workflows/ci.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,22 @@ jobs:
2727
- target: x86_64-unknown-linux-gnu
2828
steps:
2929
- uses: actions/checkout@v3
30-
- uses: dtolnay/rust-toolchain@stable
30+
- uses: dtolnay/rust-toolchain@1.91.1
3131
- run: cargo --version
3232
- run: cargo test --all-features
3333

3434
rustfmt:
3535
runs-on: ubuntu-latest
3636
steps:
3737
- uses: actions/checkout@v3
38-
- uses: dtolnay/rust-toolchain@stable
38+
- uses: dtolnay/rust-toolchain@1.91.1
3939
- run: cargo fmt --all -- --check
4040

4141
clippy:
4242
runs-on: ubuntu-latest
4343
steps:
4444
- uses: actions/checkout@v3
45-
- uses: dtolnay/rust-toolchain@stable
45+
- uses: dtolnay/rust-toolchain@1.91.1
4646
with:
4747
components: clippy
4848
- run: cargo clippy --all-features -- -D warnings
@@ -55,22 +55,22 @@ jobs:
5555
- uses: actions/checkout@v3
5656
- uses: dtolnay/rust-toolchain@master
5757
with:
58-
toolchain: stable
58+
toolchain: "1.91.1"
5959
targets: thumbv7em-none-eabi
6060
- uses: taiki-e/install-action@cargo-hack
6161
# No default features build
6262
- name: no_std / no feat
6363
run: cargo build --target thumbv7em-none-eabi --release --no-default-features
6464
- name: no_std / cargo hack
65-
run: cargo hack build --target thumbv7em-none-eabi --release --each-feature --exclude-features default,std
65+
run: cargo hack build --target thumbv7em-none-eabi --release --each-feature --exclude-features default,kat
6666

6767
msrv:
6868
name: rust-version is MSRV
6969
runs-on: ubuntu-latest
7070
continue-on-error: true
7171
steps:
7272
- uses: actions/checkout@v4
73-
- uses: dtolnay/rust-toolchain@stable
73+
- uses: dtolnay/rust-toolchain@1.91.1
7474
- run: cargo +nightly install cargo-msrv --no-default-features
7575
- run: cargo +nightly msrv --version
7676
- run: cargo +nightly msrv verify --all-features

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## Unrelease
8+
9+
* Renamed `std` feature to `kat`. Not breaking bc this is only used in testing
10+
711
## [0.11.0] - 2025-11-24
812

913
* Removed `std` flag from all but testing use

Cargo.lock

Lines changed: 63 additions & 68 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)