From d7c90c65e9ad829bcb0ef87d08306552c158d9bf Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 21 Apr 2025 01:48:02 +0100 Subject: [PATCH 1/3] Add step to run doc-tests in CI workflow --- .github/workflows/run-unit-tests.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/run-unit-tests.yml b/.github/workflows/run-unit-tests.yml index eb5b81f..5e941d8 100644 --- a/.github/workflows/run-unit-tests.yml +++ b/.github/workflows/run-unit-tests.yml @@ -20,8 +20,10 @@ jobs: uses: taiki-e/install-action@cargo-llvm-cov - name: Generate code coverage run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info + - name: Run doc-tests + run: cargo test --doc --all-features --workspace - name: Test docs generation - run: cargo doc --no-deps + run: cargo doc --no-deps - name: Upload coverage to Codecov uses: codecov/codecov-action@v3 with: From 2642af5601057e0b8cd4d158bb6dc1337e33eb0a Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 21 Apr 2025 01:51:03 +0100 Subject: [PATCH 2/3] Add GitHub Actions workflow for running doc-tests and documentation generation --- .github/workflows/run-docs-and-doc-tests.yml | 22 ++++++++++++++++++++ .github/workflows/run-unit-tests.yml | 8 +++---- 2 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/run-docs-and-doc-tests.yml diff --git a/.github/workflows/run-docs-and-doc-tests.yml b/.github/workflows/run-docs-and-doc-tests.yml new file mode 100644 index 0000000..424de3c --- /dev/null +++ b/.github/workflows/run-docs-and-doc-tests.yml @@ -0,0 +1,22 @@ +name: run-docs-and-doc-tests + +on: + pull_request: + branches: + - main + +jobs: + run-docs-and-doc-tests: + name: run-docs-and-doc-tests + runs-on: ubuntu-latest + env: + CARGO_TERM_COLOR: always + + steps: + - uses: actions/checkout@v4 + - name: Install Rust + run: rustup update stable + - name: Run doc-tests + run: cargo test --doc --all-features --workspace + - name: Test docs generation + run: cargo doc --no-deps diff --git a/.github/workflows/run-unit-tests.yml b/.github/workflows/run-unit-tests.yml index 5e941d8..3e01282 100644 --- a/.github/workflows/run-unit-tests.yml +++ b/.github/workflows/run-unit-tests.yml @@ -20,10 +20,10 @@ jobs: uses: taiki-e/install-action@cargo-llvm-cov - name: Generate code coverage run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info - - name: Run doc-tests - run: cargo test --doc --all-features --workspace - - name: Test docs generation - run: cargo doc --no-deps + # - name: Run doc-tests + # run: cargo test --doc --all-features --workspace + # - name: Test docs generation + # run: cargo doc --no-deps - name: Upload coverage to Codecov uses: codecov/codecov-action@v3 with: From adcf0d0a0b3b17413ce110d8bea6f06c1c504018 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 21 Apr 2025 01:52:06 +0100 Subject: [PATCH 3/3] Uncomment doc-tests and documentation generation steps in CI workflow --- .github/workflows/run-docs-and-doc-tests.yml | 22 -------------------- .github/workflows/run-unit-tests.yml | 8 +++---- 2 files changed, 4 insertions(+), 26 deletions(-) delete mode 100644 .github/workflows/run-docs-and-doc-tests.yml diff --git a/.github/workflows/run-docs-and-doc-tests.yml b/.github/workflows/run-docs-and-doc-tests.yml deleted file mode 100644 index 424de3c..0000000 --- a/.github/workflows/run-docs-and-doc-tests.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: run-docs-and-doc-tests - -on: - pull_request: - branches: - - main - -jobs: - run-docs-and-doc-tests: - name: run-docs-and-doc-tests - runs-on: ubuntu-latest - env: - CARGO_TERM_COLOR: always - - steps: - - uses: actions/checkout@v4 - - name: Install Rust - run: rustup update stable - - name: Run doc-tests - run: cargo test --doc --all-features --workspace - - name: Test docs generation - run: cargo doc --no-deps diff --git a/.github/workflows/run-unit-tests.yml b/.github/workflows/run-unit-tests.yml index 3e01282..5e941d8 100644 --- a/.github/workflows/run-unit-tests.yml +++ b/.github/workflows/run-unit-tests.yml @@ -20,10 +20,10 @@ jobs: uses: taiki-e/install-action@cargo-llvm-cov - name: Generate code coverage run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info - # - name: Run doc-tests - # run: cargo test --doc --all-features --workspace - # - name: Test docs generation - # run: cargo doc --no-deps + - name: Run doc-tests + run: cargo test --doc --all-features --workspace + - name: Test docs generation + run: cargo doc --no-deps - name: Upload coverage to Codecov uses: codecov/codecov-action@v3 with: