updates

.github/workflows/ci.yml

@@ -0,0 +1,199 @@
+name: CI
+
+permissions:
+  contents: read
+
+# Controls which events and branches will trigger the workflow
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main, development ]
+
+# Cancel older runs of the same PR when a new push arrives
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # Install deps once and reuse for other jobs (optional optimization)
+  install:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: 24
+          cache: 'pnpm'
+
+      - name: Create .env files
+        run: |
+          cp ./backend/.env.example ./backend/.env
+          cp ./frontend/.env.example ./frontend/.env
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      # Save node_modules so other jobs can reuse
+      - name: Cache node_modules
+        uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-modules-${{ hashFiles('pnpm-lock.yaml') }}
+
+  # Runs linting
+  lint:
+    runs-on: ubuntu-latest
+    needs: install
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          cache: 'pnpm'
+
+      - name: Restore node_modules
+        uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-modules-${{ hashFiles('pnpm-lock.yaml') }}
+
+      - name: Run Biome
+        run: pnpm biome check .
+
+  # Runs all tests
+  test:
+    runs-on: ubuntu-latest
+    needs: install
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          cache: 'pnpm'
+
+      - name: Create .env files
+        run: |
+          cp ./backend/.env.example ./backend/.env
+          cp ./frontend/.env.example ./frontend/.env
+
+      - name: Restore node_modules
+        uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-modules-${{ hashFiles('pnpm-lock.yaml') }}
+      - run: pnpm test
+
+  # Will run a quick startup check to ensure the app starts without issues
+  quick:
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+
+      - name: Create .env files
+        run: |
+          cp ./backend/.env.example ./backend/.env
+          cp ./frontend/.env.example ./frontend/.env
+
+      - name: Restore node_modules
+        uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-modules-${{ hashFiles('pnpm-lock.yaml') }}
+
+      - name: Start quick and wait for Vite ready
+        run: |
+          timeout 120s stdbuf -oL pnpm quick 2>&1 | while IFS= read -r line; do
+            # Show all output for debugging 
+            echo "$line"
+            # Remove ANSI escape codes
+            clean_line=$(echo "$line" | sed -r "s/\x1B\[[0-9;]*[mK]//g")
+            # Match "VITE <version> ready in <ms>" anywhere in the line
+            if echo "$clean_line" | grep -E ".*VITE [^ ]+ +ready in [0-9]+ ms"; then
+              echo ">>> Vite server is ready! <<<"
+              pkill -P $$ pnpm || true
+              break
+            fi
+          done || true
+
+  # Generates draft release notes (for testing only)
+  draft-release-notes:
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # needed so changelog sees full commit history
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+
+      - name: Install changelog deps
+        run: pnpm add -Dw conventional-changelog-cli conventional-changelog-conventionalcommits
+
+      - name: Generate draft release notes
+        run: |
+          # Check latest and previous tags
+          LATEST_TAG=$(if [ "$(git tag | wc -l)" -ge 1 ]; then git describe --tags --abbrev=0; fi)
+          PREV_TAG=$(if [ "$(git tag | wc -l)" -ge 2 ]; then git tag --sort=creatordate | tail -2 | head -1; fi)
+
+          echo "Latest tag: $LATEST_TAG"
+          echo "Previous tag: $PREV_TAG"
+
+          if [ -z "$PREV_TAG" ]; then
+            echo "First release — include all commits"
+            npx conventional-changelog -p conventionalcommits -r 0 -o RELEASE_NOTES.md
+          else
+            echo "Generating changelog since previous tag $PREV_TAG"
+            # Use -r 2 and output commits since PREV_TAG
+            npx conventional-changelog -p conventionalcommits -r 2 -o RELEASE_NOTES.md
+          fi
+
+      - name: Upload draft release notes
+        uses: actions/upload-artifact@v4
+        with:
+          name: draft-release-notes
+          path: RELEASE_NOTES.md

.github/workflows/release.yml

@@ -0,0 +1,53 @@
+name: Release
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - "v*" # Runs only when pushing version tags like v1.0.0, v2.3.4
+
+jobs:
+  release-notes:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # so changelog sees all commit history
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          cache: "pnpm"
+
+      - name: Install changelog deps
+        run: pnpm add -Dw conventional-changelog-cli conventional-changelog-conventionalcommits
+
+      - name: Generate release notes
+        run: |
+            # Check latest and previous tags
+            LATEST_TAG=$(if [ "$(git tag | wc -l)" -ge 1 ]; then git describe --tags --abbrev=0; fi)
+            PREV_TAG=$(if [ "$(git tag | wc -l)" -ge 2 ]; then git tag --sort=creatordate | tail -2 | head -1; fi)
+
+            echo "Latest tag: $LATEST_TAG"
+            echo "Previous tag: $PREV_TAG"
+
+            if [ -z "$PREV_TAG" ]; then
+              echo "First release — include all commits"
+              npx conventional-changelog -p conventionalcommits -r 0 -o RELEASE_NOTES.md
+            else
+              echo "Generating changelog since previous tag $PREV_TAG"
+              # Use -r 2 and output commits since PREV_TAG
+              npx conventional-changelog -p conventionalcommits -r 2 -o RELEASE_NOTES.md
+            fi
+
+      - name: Publish GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: RELEASE_NOTES.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -33,10 +33,10 @@
 </div>
 
 > [!CAUTION]
-> This is a prerelease. It does NOT meet production requirements yet and large breaking changes occur regularly. Versioned releases will begin once we have solid tests for authentication, authorization and data access. Want to contribute or discuss cella with us? Let's connect! ✉️ <[email protected]>
+> This is a prerelease. Versioned releases will start once we have enough tests for authentication, authorization and data access. Want to contribute or discuss cella with us? Let's connect! ✉️ <[email protected]>
 
 #### Contents
-- [Installation](#installation)
+- [Create app](#create-app)
 - [Architecture](/info/ARCHITECTURE.md)
 - [Roadmap](/info/ROADMAP.md)
 - [Deployment](/info/DEPLOYMENT.md)
@@ -47,18 +47,18 @@
 
 <br>
 
-## Create your own app
-Want to try cella to build a new web app with sync engine? We recommend NOT TO FORK this repo directly. Instead, use the create CLI to get started:
+## Create app
+Do **not fork** this repo directly. Use the create CLI to get started:
 
 ```bash
-pnpm create @cellajs/cella@latest
+pnpm create @cellajs/cella
 ```
 
 You now have an implementation-ready web app 🤯. But ... without any unique functionality 🤓. Read the [Quickstart](/info/QUICKSTART.md) so you can build something unique quickly.
 
 <p>&nbsp;</p>
 
-## Installation
+## Contribute
 For those that (also) want to participate in development:
 
 ```bash
@@ -89,8 +89,6 @@ pnpm dev
 
 Check it out at [localhost:3000](http://localhost:3000)! Generated API docs can be found at [localhost:4000/docs](http://localhost:4000/docs). Manage your local db with [local.drizzle.studio](http:local.drizzle.studio).
 
-
-<br />
-<br />
+<p>&nbsp;</p>
 
 💙💛 Big thank you to [drizzle](https://github.com/drizzle-team/drizzle-orm), [hono](https://github.com/honojs/hono), [tanstack-router](https://github.com/tanstack/router) & [electric](https://github.com/electric-sql/electric).