Skip to content

remove noise from contributing.md #391

remove noise from contributing.md

remove noise from contributing.md #391

Workflow file for this run

name: Rust
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
check:
name: Check (--examples)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- run: cargo check --examples --tests
check_minimal:
name: Check (no default features)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- run: cargo check --no-default-features
test:
name: Test Suite
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- run: cargo test
- run: cargo test --all-features
- run: cargo test --examples
fmt:
name: Rustfmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
components: rustfmt
- run: cargo fmt --all -- --check
clippy:
name: Clippy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
components: clippy
- run: cargo clippy --all-features --tests -- -D clippy::all
rustdoc:
name: rustdoc
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
# assert there are no warnings
- run: '[ -z "$(cargo doc --no-deps || grep warning)" ]'
# assert cargo doc succeeded
- run: cargo doc --no-deps
# assert that there's no broken links (links to examples like to break)
# remove some known-bad files that we know hyperlink can't handle, to
# silence errors
- run: rm target/doc/help.html target/doc/settings.html
- uses: untitaker/hyperlink@0.1.42
with:
args: target/doc/