Skip to content

Commit 8fd014e

Browse files
Thom Chiovolonithomcc
authored andcommitted
Add libmimalloc-sys-test to CI, and verify that documentation links resolve in CI
1 parent b80b1c9 commit 8fd014e

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

.github/workflows/ci.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@ jobs:
5858
command: test
5959
args: --no-default-features
6060

61+
- name: Test libmimalloc-sys crate bindings.
62+
uses: actions-rs/cargo@v1
63+
with:
64+
command: run
65+
args: -p libmimalloc-sys-test
66+
6167
lint:
6268
name: Rustfmt / Clippy
6369
runs-on: ubuntu-latest
@@ -84,3 +90,36 @@ jobs:
8490
with:
8591
command: clippy
8692
args: --workspace -- -D warnings
93+
94+
# Detect cases where documentation links would be dead
95+
doc:
96+
name: Check documentation
97+
runs-on: ubuntu-latest
98+
steps:
99+
100+
- uses: actions/checkout@v2
101+
with:
102+
submodules: recursive
103+
104+
- uses: actions-rs/toolchain@v1
105+
with:
106+
profile: minimal
107+
toolchain: nightly
108+
override: true
109+
110+
# Note: We need to use nightly rust, and `cargo rustdoc` (yes, not `cargo
111+
# doc`) to actually get it to respect -D warnings... Using nightly also
112+
# gets us the nicer syntax for linking to functions, and is in-line with
113+
# what docs.rs uses.
114+
115+
- name: 'Check documentation links in `mimalloc`'
116+
uses: actions-rs/cargo@v1
117+
with:
118+
command: rustdoc
119+
args: -- -D warnings
120+
121+
- name: 'Check documentation links in `libmimalloc-sys`'
122+
uses: actions-rs/cargo@v1
123+
with:
124+
command: rustdoc
125+
args: -p libmimalloc-sys -- -D warnings

0 commit comments

Comments
 (0)