Skip to content

docs: add todo

docs: add todo #37

Workflow file for this run

name: Rust
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
on:
push:
branches:
- main
- develop
pull_request:
types: [ opened, synchronize, reopened ]
branches:
- main
- develop
env:
CARGO_TERM_COLOR: always
SQLX_VERSION: 0.7.4 # When changing ensure the cache is invalidated
SQLX_FEATURES: "rustls,mysql"
jobs:
test:
name: Test
runs-on: ubuntu-latest
services:
mysql:
image: mysql:latest
env:
MYSQL_USER: db_user
MYSQL_PASSWORD: password
MYSQL_DATABASE: chat_demo
MYSQL_ROOT_PASSWORD: password
MYSQL_ROOT_HOST: "%"
ports:
- 3306:3306
redis:
image: redis:7
ports:
- 6379:6379
steps:
- uses: wykies/checkout@main
with:
submodules: recursive
- uses: wykies/setup-rust-toolchain@main
- name: Install sqlx-cli
run:
cargo install sqlx-cli
--version=${{ env.SQLX_VERSION }}
--features ${{ env.SQLX_FEATURES }}
--no-default-features
--locked
- name: Migrate database
run: |
sudo apt-get install mysql-client -y
cd crates/chat-app-server && SKIP_DOCKER=true ./scripts/init_db.sh
- name: Check sqlx prepared queries are is up-to-date
run: |
cargo sqlx prepare --check --workspace -- --bins --tests --all-features
- name: Run tests
run: cargo test
fmt:
name: Rustfmt
runs-on: ubuntu-latest
steps:
- uses: wykies/checkout@main
with:
submodules: recursive
- uses: wykies/setup-rust-toolchain@main
with:
components: rustfmt
cache: false
- name: Enforce formatting
run: cargo fmt --check
clippy:
name: Clippy
runs-on: ubuntu-latest
services:
mysql:
image: mysql:latest
env:
MYSQL_USER: db_user
MYSQL_PASSWORD: password
MYSQL_DATABASE: chat_demo
MYSQL_ROOT_PASSWORD: password
MYSQL_ROOT_HOST: "%"
ports:
- 3306:3306
steps:
- uses: wykies/checkout@main
with:
submodules: recursive
- uses: wykies/setup-rust-toolchain@main
with:
components: clippy
- name: Linting
run: cargo clippy -- -D warnings
wasm:
name: Clippy WASM
runs-on: ubuntu-latest
steps:
- uses: wykies/checkout@main
with:
submodules: recursive
- uses: wykies/setup-rust-toolchain@main
with:
target: wasm32-unknown-unknown
components: clippy
- name: Linting
run: cargo clippy --target="wasm32-unknown-unknown" --package chat-app-client -- -D warnings