Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add gitub workflow action to check docs
  • Loading branch information
alamb committed Apr 18, 2023
commit 2ab38959c1f636ed79a6518ed53e4483a77ec1a7
23 changes: 21 additions & 2 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ jobs:
- name: Verify Working Directory Clean
run: git diff --exit-code

# Run doc tests
# Run `cargo test doc` (test documentation examples)
linux-test-doc:
name: cargo doctest (amd64)
name: cargo test --doc (amd64)
needs: [ linux-build-lib ]
runs-on: ubuntu-latest
container:
Expand All @@ -157,6 +157,25 @@ jobs:
- name: Verify Working Directory Clean
run: git diff --exit-code

# Run `cargo doc` to ensure
linux-rustdoc:
name: cargo --doc
needs: [ linux-build-lib ]
runs-on: ubuntu-latest
container:
image: amd64/rust
steps:
- uses: actions/checkout@v3
- name: Setup Rust toolchain
uses: ./.github/actions/setup-builder
with:
rust-version: stable
# Note: this does not include dictionary_expressions to reduce codegen
- name: Run cargo doc
run: |
export RUSTDOCFLAGS= "-D warnings -A rustdoc::private-intra-doc-links"
cargo doc --document-private-items --no-deps --workspace

# verify that the benchmark queries return the correct results
verify-benchmark-results:
name: verify benchmark results (amd64)
Expand Down