From b983a1ab65e443db57bf9beeba517c50ea030963 Mon Sep 17 00:00:00 2001 From: ArtemIsmagilov Date: Mon, 16 Dec 2024 03:53:07 +0400 Subject: [PATCH 1/3] style checking the code base before run tests --- .github/workflows/compile_and_test.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/compile_and_test.yml b/.github/workflows/compile_and_test.yml index b15cf9b..64eea22 100644 --- a/.github/workflows/compile_and_test.yml +++ b/.github/workflows/compile_and_test.yml @@ -41,6 +41,8 @@ jobs: steps: - name: Checkout sources uses: actions/checkout@v4 + - name: Checking style + run: cargo fmt --all -- --check - name: Create Redis containers run: | cd /home/runner/work/rustis/rustis/redis/ From 0113a1e45545639428ae089677039f6787d3aa49 Mon Sep 17 00:00:00 2001 From: ArtemIsmagilov Date: Mon, 16 Dec 2024 04:12:52 +0400 Subject: [PATCH 2/3] writed in README - run style check --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d01662..12e70db 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ An asynchronous Redis client for Rust. - [![Crate](https://img.shields.io/crates/v/rustis.svg)](https://crates.io/crates/rustis) [![docs.rs](https://docs.rs/rustis/badge.svg)](https://docs.rs/rustis) [![Build](https://github.com/dahomey-technologies/rustis/actions/workflows/compile_and_test.yml/badge.svg)](https://github.com/dahomey-technologies/rustis/actions/workflows/compile_and_test.yml) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) # Documentation + [Official Documentation](https://docs.rs/rustis/latest/rustis/) # Philosophy + * Low allocations * Full async library * Lock free implementation @@ -17,6 +18,7 @@ An asynchronous Redis client for Rust. * Multiplexing as a core feature # Features + * Full documentation with multiple examples * Support all [Redis Commands](https://redis.io/commands/) until Redis 7.0 * Async support ([tokio](https://tokio.rs/) or [async-std](https://async.rs/)) @@ -74,7 +76,9 @@ async fn main() -> Result<()> { 1. From the `redis` directory, run `docker_up.sh` or `docker_up.cmd` 2. run `cargo test --features pool,redis-stack,tokio-tls` (Tokio runtime) 3. run `cargo test --no-default-features --features redis-stack,async-std-runtime,async-std-tls` (async-std runtime) +4. run `cargo fmt --all -- --check` # Benchmarks + 1. From the `redis` directory, run `docker_up.sh` or `docker_up.cmd` 2. run `cargo bench` From 8f8b8551e300a697b6559d1d133036d9fa00f605 Mon Sep 17 00:00:00 2001 From: ArtemIsmagilov <118372045+ArtemIsmagilov@users.noreply.github.com> Date: Fri, 20 Dec 2024 05:22:22 +0400 Subject: [PATCH 3/3] move checking style in check job --- .github/workflows/compile_and_test.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/compile_and_test.yml b/.github/workflows/compile_and_test.yml index 64eea22..871f52b 100644 --- a/.github/workflows/compile_and_test.yml +++ b/.github/workflows/compile_and_test.yml @@ -32,6 +32,8 @@ jobs: uses: actions/checkout@v4 - name: Run cargo check run: cargo check + - name: Checking style + run: cargo fmt --all -- --check test: name: Test @@ -41,8 +43,6 @@ jobs: steps: - name: Checkout sources uses: actions/checkout@v4 - - name: Checking style - run: cargo fmt --all -- --check - name: Create Redis containers run: | cd /home/runner/work/rustis/rustis/redis/