Skip to content

docs: add rust api doc #216

docs: add rust api doc

docs: add rust api doc #216

Workflow file for this run

name: CI
on:
push:
branches: [ master, develop, staging, trying ]
pull_request:
branches: [ master ]
defaults:
run:
shell: bash
env:
CARGO_TERM_COLOR: always
RUSTFLAGS: -D warnings
RUST_BACKTRACE: full
jobs:
rustfmt:
name: Checks / Format
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: 1.75.0
components: rustfmt
- name: Run
run: make fmt
clippy:
name: Checks / Clippy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: 1.75.0
components: clippy
- name: Run
run: make clippy
test-msrv:
name: Tests / Build (MSRV)
needs: [ rustfmt, clippy ]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: 1.56.1 # MSRV
- name: Run
run: make ci-msrv
test-crates:
name: Tests / Build & Test
needs: [ rustfmt, clippy ]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: 1.75.0
- name: Run
run: make ci-crates
test-examples:
name: Tests / Run Examples
needs: [ rustfmt, clippy ]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: 1.75.0
- name: Run
run: make ci-examples
success:
name: Success
if: ${{ success() }}
needs: [ test-crates, test-examples ]
runs-on: ubuntu-latest
steps:
- name: Succeed
run: exit 0