ci: add a cargo doc job
#3555
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Test Core | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| env: | |
| RUSTFLAGS: -D warnings | |
| jobs: | |
| test: | |
| runs-on: ${{ matrix.platform.os }} | |
| name: "${{ matrix.platform.os }} ${{ matrix.platform.rs }} ${{ matrix.features }}" | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| platform: | |
| - os: ubuntu-latest | |
| rs: 1.80.0 | |
| - os: ubuntu-latest | |
| rs: stable | |
| - os: macos-latest | |
| rs: 1.80.0 | |
| - os: macos-latest | |
| rs: stable | |
| features: ['', '--features unstable,legacy,__abi-generate'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "${{ matrix.platform.rs }} with rustfmt, and wasm32" | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: ${{ matrix.platform.rs }} | |
| default: true | |
| target: wasm32-unknown-unknown | |
| - uses: Swatinem/rust-cache@v1 | |
| # - name: Downgrade dependencies | |
| # run: | | |
| # cargo update -p [email protected] --precise 4.4.18 | |
| # cd examples/adder && cargo update -p [email protected] --precise 4.4.18 | |
| - name: print rustc && rustdoc version | |
| run: rustc --version && rustdoc --version | |
| - name: test | |
| run: cargo test --all ${{ matrix.features }} | |
| lint: | |
| name: Clippy and fmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| default: true | |
| components: rustfmt, clippy | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: Test Format | |
| run: cargo fmt -- --check | |
| - run: cargo clippy --tests --all-features -- -Dclippy::all | |
| compilation: | |
| name: Compilation tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install stable toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| default: true | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: Compilation tests | |
| run: cargo test --package near-sdk --test compilation_tests --features __abi-generate --features unstable -- compilation_tests --exact --nocapture | |
| windows: | |
| name: Windows | |
| runs-on: windows-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Setup Windows toolchain" | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| default: true | |
| - uses: Swatinem/rust-cache@v1 | |
| - run: cargo check -p near-sdk --features unstable,legacy | |
| - run: cargo check -p near-sdk --no-default-features | |
| - run: cargo check -p near-sdk --no-default-features --features legacy | |
| - run: cargo check -p near-sdk --no-default-features --features unstable | |
| - run: cargo check -p near-contract-standards | |
| audit: | |
| name: Audit | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Sources | |
| uses: actions/checkout@v4 | |
| - name: Install Toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| default: true | |
| - uses: Swatinem/rust-cache@v1 | |
| - name: Install Audit | |
| run: cargo install cargo-audit | |
| - name: Run Audit | |
| run: cargo audit | |
| # there're sometimes warnings, which signal, that the generated doc | |
| # won't look as expected, when rendered, and sometimes errors, which will prevent doc from being | |
| # generated at release time altogether. | |
| cargo-doc: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: stable | |
| default: true | |
| - name: run cargo doc | |
| env: | |
| RUSTDOCFLAGS: -D warnings | |
| run: | | |
| cargo doc -p near-sdk --features unstable,legacy,unit-testing,__macro-docs | |
| cargo doc -p near-sdk-macros | |
| cargo doc -p near-contract-standards --no-deps | |
| cargo doc -p near-sys |