Skip to content

Commit e0f7aee

Browse files
committed
feat(ci): deny cargo doc warnings
1 parent 9273717 commit e0f7aee

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

.github/workflows/ci.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
fail-fast: false
2929
matrix:
3030
os: [ubuntu-latest, macos-latest]
31-
name: [build, check-m2-native, check-clippy, check-clippy-verify-signature, test-fvm, test, integration, conformance, calibration, doctest]
31+
name: [build, check-m2-native, check-clippy, check-clippy-verify-signature, test-fvm, test, integration, conformance, calibration, doctest, doc]
3232
include:
3333
- name: build
3434
key: v3
@@ -84,6 +84,10 @@ jobs:
8484
# we disable default features because Rust will otherwise unify them and turn on opencl in CI.
8585
# we also disable test packages, given they are unlikely to contain any doctests and would double the compilation duration
8686
args: --all --no-default-features --exclude fvm_conformance_tests --exclude fvm_integration_tests --exclude "*actor" --doc
87+
- name: doc
88+
key: v3
89+
command: doc
90+
args: --all --no-default-features --exclude fvm_conformance_tests --exclude fvm_integration_tests --exclude "*actor"
8791
exclude:
8892
- os: macos-latest
8993
name: check-m2-native
@@ -99,9 +103,12 @@ jobs:
99103
name: calibration
100104
- os: macos-latest
101105
name: doctest
106+
- os: macos-latest
107+
name: doc
102108
env:
103109
CARGO_INCREMENTAL: 0
104110
CARGO_TERM_COLOR: always
111+
RUSTDOCFLAGS: "--Dwarnings"
105112
name: ${{matrix.os}} - ${{ matrix.name }}
106113
steps:
107114
- name: Checking out fvm

Makefile

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
all: build
2-
.PHONY: all
32

43
build:
54
cargo build
6-
.PHONY: build
75

86
clean:
97
cargo clean
@@ -18,3 +16,8 @@ license:
1816
doctest:
1917
# We disable test packages, given they are unlikely to contain any doctests and would double the compilation duration.
2018
cargo test --all --exclude fvm_conformance_tests --exclude fvm_integration_tests --exclude "*actor" --doc
19+
20+
doc:
21+
RUSTDOCFLAGS="-D warnings" cargo doc --all --no-default-features --exclude fvm_conformance_tests --exclude fvm_integration_tests --exclude "*actor"
22+
23+
.PHONY: all build clean lint license doctest doc

0 commit comments

Comments
 (0)