summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorMarco Ieni <11428655+MarcoIeni@users.noreply.github.com>2021-04-15 22:53:21 +0200
committerAndrew Gallant <jamslam@gmail.com>2021-05-31 21:51:18 -0400
commitb3a6a69f9d6eb00f4ce8fa5dfc4f2ac2327e75e1 (patch)
treef67e8eaac981b4965bafa8e15be178b29768686a /.github
parent26a29c750ee962100ed5abf97a43feffcf3fe984 (diff)
ci: check docs for all crates
This also replaces '--all' in Cargo commands with '--workspace'. The former has apparently been deprecated. We also fix a couple warnings that this new step detected. Closes #1848
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/ci.yml25
1 files changed, 21 insertions, 4 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 256bd822..5d821a5e 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -118,10 +118,10 @@ jobs:
echo "target flag is: ${{ env.TARGET_FLAGS }}"
- name: Build ripgrep and all crates
- run: ${{ env.CARGO }} build --verbose --all ${{ env.TARGET_FLAGS }}
+ run: ${{ env.CARGO }} build --verbose --workspace ${{ env.TARGET_FLAGS }}
- name: Build ripgrep with PCRE2
- run: ${{ env.CARGO }} build --verbose --all --features pcre2 ${{ env.TARGET_FLAGS }}
+ run: ${{ env.CARGO }} build --verbose --workspace --features pcre2 ${{ env.TARGET_FLAGS }}
# This is useful for debugging problems when the expected build artifacts
# (like shell completions and man pages) aren't generated.
@@ -139,7 +139,7 @@ jobs:
- name: Run tests with PCRE2 (sans cross)
if: matrix.target == ''
- run: ${{ env.CARGO }} test --verbose --all --features pcre2 ${{ env.TARGET_FLAGS }}
+ run: ${{ env.CARGO }} test --verbose --workspace --features pcre2 ${{ env.TARGET_FLAGS }}
- name: Run tests without PCRE2 (with cross)
# These tests should actually work, but they almost double the runtime.
@@ -147,7 +147,7 @@ jobs:
# enabled, every integration test is run twice: one with the default
# regex engine and once with PCRE2.
if: matrix.target != ''
- run: ${{ env.CARGO }} test --verbose --all ${{ env.TARGET_FLAGS }}
+ run: ${{ env.CARGO }} test --verbose --workspace ${{ env.TARGET_FLAGS }}
- name: Test for existence of build artifacts (Windows)
if: matrix.os == 'windows-2019'
@@ -194,3 +194,20 @@ jobs:
- name: Check formatting
run: |
cargo fmt --all -- --check
+
+ docs:
+ name: Docs
+ runs-on: ubuntu-20.04
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v2
+ - name: Install Rust
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: stable
+ profile: minimal
+ override: true
+ - name: Check documentation
+ env:
+ RUSTDOCFLAGS: -D warnings
+ run: cargo doc --no-deps --document-private-items --workspace