Skip to content

Commit 1487df4

Browse files
committed
ci(doc consistency): check that lib.rs and README.md are consistent
1 parent 22b29ee commit 1487df4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

.github/workflows/ci.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ jobs:
1616
with:
1717
toolchain: stable
1818
components: rustfmt
19+
- name: Install cargo-readme
20+
run: cargo install cargo-readme
21+
- name: Check doc consistency
22+
shell: bash
23+
run: diff -q README.md <(cargo readme)
24+
|| { echo "::error::Update lib.rs then use cargo-readme to update README.md"; exit 1; }
1925
- name: rustfmt
2026
run: cargo fmt --all -- --check
2127
- name: docs

0 commit comments

Comments
 (0)