Skip to content

More doc updates

More doc updates #515

Workflow file for this run

name: CI
on:
push:
branches:
- main
pull_request:
types: [opened, reopened, synchronize]
jobs:
test:
name: ${{matrix.name}}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include:
- name: Run the default tests
package: ractor
# flags:
- name: Test ractor in async_std
package: ractor
flags: --features async-std
- name: Test ractor with the `cluster` feature
package: ractor
flags: -F cluster
- name: Test ractor with the `blanket_serde` feature
package: ractor
flags: -F blanket_serde
- name: Test ractor_cluster
package: ractor_cluster
# flags:
steps:
- uses: actions/checkout@main
- name: Install rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: ${{matrix.name}}
uses: actions-rs/cargo@v1
with:
command: test
args: --package ${{matrix.package}} ${{matrix.flags}}
- name: Test everything
uses: actions-rs/cargo@v1
with:
command: test
clippy:
name: Clippy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
- name: Install minimal stable with clippy
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
components: clippy
override: true
- name: Run Clippy
uses: actions-rs/cargo@v1
with:
command: clippy
args: --all -- -D clippy::all -D warnings
rustfmt:
name: rustfmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
- name: Install minimal stable with rustfmt
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
components: rustfmt
override: true
- name: Run rustfmt
uses: actions-rs/cargo@v1
with:
command: fmt
args: --all -- --check
docs:
name: docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
- name: Install minimal stable with rustfmt
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
components: rustfmt
override: true
- name: Run cargo doc on release profile
uses: actions-rs/cargo@v1
with:
command: doc
args: --lib -r
benches:
name: benches
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
- name: Install rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
- name: Compile benchmarks
uses: actions-rs/cargo@v1
with:
command: bench
args: --no-run