docs: add opt-in table of contents into readme #343
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: check | |
on: | |
push: | |
branches: | |
- master | |
pull_request: | |
branches: | |
- master | |
workflow_dispatch: {} | |
jobs: | |
clippy: | |
name: Clippy | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
rust: [stable, beta, nightly] | |
steps: | |
- name: Checkout | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Install rust (${{ matrix.rust }}) | |
uses: dtolnay/rust-toolchain@7b1c307e0dcbda6122208f10795a713336a9b35a | |
with: | |
components: clippy | |
toolchain: ${{ matrix.rust }} | |
- name: Run clippy | |
run: cargo clippy --all-features -- -D warnings | |
fmt: | |
name: Formatting | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Install rust (stable) | |
uses: dtolnay/rust-toolchain@7b1c307e0dcbda6122208f10795a713336a9b35a | |
with: | |
components: rustfmt | |
toolchain: stable | |
- name: Run rustfmt | |
run: cargo fmt --check | |
build_and_test: | |
name: Build and test | |
runs-on: ${{ matrix.os }}-latest | |
strategy: | |
matrix: | |
os: [ubuntu, macos, windows] | |
rust: [stable, beta, nightly] | |
steps: | |
- name: Checkout | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Install rust (${{ matrix.rust }}) | |
uses: dtolnay/rust-toolchain@7b1c307e0dcbda6122208f10795a713336a9b35a | |
with: | |
toolchain: ${{ matrix.rust }} | |
- name: Cache | |
uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2 | |
with: | |
path: | | |
~/.cargo | |
target | |
key: ${{ matrix.os }}-${{ matrix.rust }}-${{ hashFiles('Cargo.lock') }} | |
restore-keys: | | |
${{ matrix.os }}-${{ matrix.rust }}-${{ hashFiles('Cargo.lock') }} | |
${{ matrix.os }}-${{ matrix.rust }}- | |
- name: Build | |
run: cargo build --all-targets | |
- name: Run tests | |
run: cargo test | |
- name: Perform test application run (IPv4) | |
run: cargo run -- --name-servers-ip v4 --lookup-ip v4 --timeout 1 | |
# Disabled due to GitHub Actions not supporting IPv6 yet. | |
# - name: Perform test application run (IPv6) | |
# run: cargo run -- --name-servers-ip v6 --lookup-ip v6 --timeout 1 | |
msrv: | |
name: Check minimal supported rust version (MSRV). | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Install rust (stable) | |
uses: dtolnay/rust-toolchain@7b1c307e0dcbda6122208f10795a713336a9b35a | |
with: | |
toolchain: stable | |
- name: Cache | |
uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2 | |
with: | |
path: | | |
~/.cargo | |
target | |
key: ${{ runner.os }}-msrv | |
- name: Install cargo-msrv | |
run: cargo install cargo-msrv | |
- name: Check msrv | |
run: cargo msrv find --log-target stdout --log-level info |