Skip to content

add docs

add docs #3

Workflow file for this run

name: CI
on:
push:
branches: [ "develop" ]
pull_request:
branches: [ "master", "develop" ]
env:
CARGO_TERM_COLOR: always
RUST_LOG: info
jobs:
fmt:
name: fmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt
- name: Enforce formatting
run: cargo fmt --check
build:
runs-on: ubuntu-latest
needs: fmt
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Build
run: cargo build --verbose
clippy:
name: clippy
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
with:
components: clippy
- uses: Swatinem/rust-cache@v2
- name: Clippy lints
run: cargo clippy -- -D warnings
test:
runs-on: ubuntu-latest
needs: build
steps:
- uses: actions/checkout@v3
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Start EdgeDB
run: docker compose up -d
- name: Run tests
env:
EDGEDB_HOST: localhost
EDGEDB_PORT: 5656
EDGEDB_USER: edgedb
EDGEDB_PASSWORD: edgedb
EDGEDB_CLIENT_TLS_SECURITY: insecure
run: cargo test --verbose -- --nocapture