Enhance documentation and add Redis tracking with CI tests

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/build_image.yaml

@@ -1,83 +1,83 @@
-name: build-and-push-images
-
-on:
-  push:
-    branches: ["main"]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  packages: write
-
-env:
-  REGISTRY: ghcr.io
-  ORG: ${{ github.repository_owner }}
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        image: [cuscuta-chilo, cuscuta-worker, cuscuta-entry]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: docker/setup-buildx-action@v3
-
-      - name: Login to GHCR
-        uses: docker/login-action@v3
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Read version from Cargo.toml
-        id: ver
-        shell: bash
-        run: |
-          set -euo pipefail
-          cargo_toml="Cargo.toml"
-          version="$(python3 - "$cargo_toml" <<'PY'
-          import sys, tomllib
-          with open(sys.argv[1], "rb") as f:
-              obj = tomllib.load(f)
-          print(obj["workspace"]["package"]["version"])
-          PY
-          )"
-          echo "version=$version" >> "$GITHUB_OUTPUT"
-
-      - name: Build and push
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          file: ./${{ matrix.image }}/Dockerfile
-          push: true
-          tags: |
-            ${{ env.REGISTRY }}/${{ env.ORG }}/${{ matrix.image }}:${{ steps.ver.outputs.version }}
-            ${{ env.REGISTRY }}/${{ env.ORG }}/${{ matrix.image }}:sha-${{ github.sha }}
-
-  helm:
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Helm
-        uses: azure/setup-helm@v4
-
-      - name: Install helm-push plugin
-        run: helm plugin install --verify=false https://github.com/chartmuseum/helm-push
-
-      - name: Login to GHCR
-        uses: docker/login-action@v3
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Package and push Helm chart
-        run: |
-          helm package ./helm
+name: build-and-push-images
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+
+env:
+  REGISTRY: ghcr.io
+  ORG: ${{ github.repository_owner }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        image: [cuscuta-chilo, cuscuta-worker, cuscuta-entry]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: docker/setup-buildx-action@v3
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Read version from Cargo.toml
+        id: ver
+        shell: bash
+        run: |
+          set -euo pipefail
+          cargo_toml="Cargo.toml"
+          version="$(python3 - "$cargo_toml" <<'PY'
+          import sys, tomllib
+          with open(sys.argv[1], "rb") as f:
+              obj = tomllib.load(f)
+          print(obj["workspace"]["package"]["version"])
+          PY
+          )"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./${{ matrix.image }}/Dockerfile
+          push: true
+          tags: |
+            ${{ env.REGISTRY }}/${{ env.ORG }}/${{ matrix.image }}:${{ steps.ver.outputs.version }}
+            ${{ env.REGISTRY }}/${{ env.ORG }}/${{ matrix.image }}:sha-${{ github.sha }}
+
+  helm:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Helm
+        uses: azure/setup-helm@v4
+
+      - name: Install helm-push plugin
+        run: helm plugin install --verify=false https://github.com/chartmuseum/helm-push
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Package and push Helm chart
+        run: |
+          helm package ./helm
           helm push cuscuta-*.tgz oci://${{ env.REGISTRY }}/${{ env.ORG }}/charts

.github/workflows/pr_check.yaml

@@ -1,46 +1,56 @@
-name: cargo-code-check
-
-on:
-  pull_request:
-    types: [opened, synchronize, reopened]
-    branches: ["main"]
-    paths-ignore:
-      - '*.md'
-      - '.github/**'
-      - 'helm/**'
-
-env:
-  CARGO_TERM_COLOR: always
-  RUSTFLAGS: "-D warnings"
-
-jobs:
-  fmt:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
-        with:
-          components: rustfmt
-      - run: cargo fmt --all --check
-
-  check:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
-      - name: Install native deps (chilo)
-        run: sudo apt-get update && sudo apt-get install -y clang cmake pkg-config
-      - uses: Swatinem/rust-cache@v2
-      - run: cargo check --workspace
-
-  clippy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
-        with:
-          components: clippy
-      - name: Install native deps (chilo)
-        run: sudo apt-get update && sudo apt-get install -y clang cmake pkg-config
-      - uses: Swatinem/rust-cache@v2
+name: cargo-code-check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches: ["main"]
+    paths-ignore:
+      - '*.md'
+      - '.github/**'
+      - 'helm/**'
+
+env:
+  CARGO_TERM_COLOR: always
+  RUSTFLAGS: "-D warnings"
+
+jobs:
+  fmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - run: cargo fmt --all --check
+
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Install native deps (chilo)
+        run: sudo apt-get update && sudo apt-get install -y clang cmake pkg-config
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo check --workspace
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Install native deps (chilo)
+        run: sudo apt-get update && sudo apt-get install -y clang cmake pkg-config
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo test --workspace
+
+  clippy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - name: Install native deps (chilo)
+        run: sudo apt-get update && sudo apt-get install -y clang cmake pkg-config
+      - uses: Swatinem/rust-cache@v2
       - run: cargo clippy --workspace -- -D warnings

.gitignore

@@ -1,4 +1,5 @@
-docker-compose-local.yaml
-tmp
-draft
-target
+docker-compose-local.yaml
+tmp
+draft
+target
+*.vim