Skip to content

Add doctests (as nextest doesn't do these yet) #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 14, 2024
Merged

Add doctests (as nextest doesn't do these yet) #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c44100d
Add doctests (as nextest doesn't do these yet)
AnotherDaniel May 14, 2024
b3d50f1
Fix json output generation
AnotherDaniel May 14, 2024
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
26 changes: 25 additions & 1 deletion .github/workflows/check.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ on:
test_results_url:
description: "URL of the test results artifact"
value: ${{ jobs.nextest.outputs.test_results_url }}
doctest_results_url:
description: "URL of the doctest results artifact"
value: ${{ jobs.doctest.outputs.test_results_url }}
workflow_dispatch:

concurrency:
Expand Down Expand Up @@ -147,4 +150,25 @@ jobs:
with:
name: test-results
path: testresults--all-features.json


doctest:
# Run doctests separately, as nextest doesn't yet (https://github.com/nextest-rs/nextest/issues/16)
outputs:
test_results_url: ${{ steps.doctest_results.outputs.artifact-url }}
runs-on: ubuntu-latest
env:
RUSTDOCFLAGS: -Dwarnings
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ env.RUST_TOOLCHAIN }}
- name: Run doc tests
run: |
RUSTC_BOOTSTRAP=1 cargo test --doc -- -Z unstable-options --format json --report-time > doctestresults--all-features.json
- name: Upload doctest results artifact
id: doctest_results
uses: actions/upload-artifact@v4
with:
name: doctest-results
path: doctestresults--all-features.json