Merge pull request #2 from flyingrobots/git-stunts

Git Stunts Prep

Author: flyingrobots

.dockerignore

@@ -0,0 +1,5 @@
+node_modules
+.git
+test-repo
+playwright-report
+test-results

.github/workflows/ci.yml

@@ -7,9 +7,39 @@ on:
     branches: [ main ]
 
 jobs:
+  dependency-guard:
+    name: Dependency Guard + Clean Install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Verify Dependency Integrity (Pre-Install)
+        run: npm run check:deps
+
+      - name: Clean Install
+        run: npm ci
+
+      - name: Verify Dependency Integrity (Post-Install)
+        run: npm run check:deps
+
+      - name: Configure Git User
+        run: |
+          git config --global user.email "ci@git-cms.local"
+          git config --global user.name "CI Bot"
+          git config --global init.defaultBranch main
+
+      - name: Run Local Integration Tests
+        run: npm run test:local
+
   unit-test:
     name: Unit Tests (Docker)
     runs-on: ubuntu-latest
+    needs: dependency-guard
     steps:
       - uses: actions/checkout@v4
 
@@ -19,14 +49,15 @@ jobs:
   e2e-test:
     name: E2E Tests (Playwright)
     runs-on: ubuntu-latest
+    needs: dependency-guard
     container:
       image: mcr.microsoft.com/playwright:v1.57.0-jammy
     steps:
       - uses: actions/checkout@v4
 
       - uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '22'
           cache: 'npm'
 
       # Git is required in the container to perform plumbing operations during E2E tests
@@ -50,4 +81,4 @@ jobs:
         with:
           name: playwright-report
           path: playwright-report/
-          retention-days: 30
+          retention-days: 30

.github/workflows/test-setup.yml

@@ -0,0 +1,34 @@
+name: Test Setup Script
+
+on:
+  push:
+    branches: [main, git-stunts]
+    paths:
+      - 'scripts/setup.sh'
+      - 'test/setup.bats'
+      - 'test/run-setup-tests.sh'
+      - 'test/Dockerfile.bats'
+  pull_request:
+    paths:
+      - 'scripts/setup.sh'
+      - 'test/setup.bats'
+      - 'test/run-setup-tests.sh'
+      - 'test/Dockerfile.bats'
+
+jobs:
+  test-setup-script:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run BATS tests
+        run: npm run test:setup
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: bats-test-results
+          path: test-results/

.gitignore

@@ -6,3 +6,20 @@ playwright-report/
 cms-chunks-*/
 cms-upload-*/
 git-cms-test-*/
+.obsidian/
+
+# LaTeX artifacts
+docs/adr-tex-2/*.aux
+docs/adr-tex-2/*.log
+docs/adr-tex-2/*.out
+docs/adr-tex-2/*.toc
+docs/adr-tex-2/*.synctex.gz
+docs/adr-tex-2/*.fls
+docs/adr-tex-2/*.fdb_latexmk
+docs/adr-tex-2/*.bbl
+docs/adr-tex-2/*.blg
+docs/adr-tex-2/*.idx
+docs/adr-tex-2/*.ind
+docs/adr-tex-2/*.ilg
+docs/adr-tex-2/*.lof
+docs/adr-tex-2/*.lot

Dockerfile

@@ -1,14 +1,14 @@
 # syntax=docker/dockerfile:1
 
 # Base stage
-FROM node:20-slim AS base
+FROM node:22-slim AS base
 ENV NODE_ENV=production
-# Install Git (Required for git-cms)
-RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/*
+RUN apt-get update && apt-get install -y --no-install-recommends git && rm -rf /var/lib/apt/lists/*
 WORKDIR /app
 
 # Deps stage
 FROM base AS deps
+RUN apt-get update && apt-get install -y --no-install-recommends python3 make g++ && rm -rf /var/lib/apt/lists/*
 COPY package.json package-lock.json* ./
 RUN npm ci --include=dev
 
@@ -17,19 +17,17 @@ FROM base AS dev
 ENV NODE_ENV=development
 COPY --from=deps /app/node_modules ./node_modules
 COPY . .
-# Configure Git for Dev
-RUN git config --global user.email "dev@git-cms.local"
-RUN git config --global user.name "Git CMS Dev"
-RUN git config --global init.defaultBranch main
+RUN git config --global user.email "dev@git-cms.local" \
+ && git config --global user.name "Git CMS Dev" \
+ && git config --global init.defaultBranch main
 CMD ["npm", "run", "serve"]
 
 # Test stage
 FROM base AS test
 ENV NODE_ENV=test
 COPY --from=deps /app/node_modules ./node_modules
 COPY . .
-# Configure Git for Test
-RUN git config --global user.email "bot@git-cms.local"
-RUN git config --global user.name "Git CMS Bot"
-RUN git config --global init.defaultBranch main
+RUN git config --global user.email "bot@git-cms.local" \
+ && git config --global user.name "Git CMS Bot" \
+ && git config --global init.defaultBranch main
 CMD ["npm", "run", "test:local"]

GETTING_STARTED.md

@@ -0,0 +1,73 @@
+# Getting Started with Git CMS
+
+This quick guide is the lightweight entry point. For the full Docker-focused walkthrough in the docs folder, see [`docs/GETTING_STARTED.md`](docs/GETTING_STARTED.md).
+
+---
+
+## Prerequisites
+
+- Git
+- Node.js 22+
+- Docker Desktop (recommended for safe testing)
+
+---
+
+## Installation
+
+### Option A: Local CLI Install
+
+```bash
+git clone https://github.com/flyingrobots/git-cms.git
+cd git-cms
+npm install
+npm link
+```
+
+### Option B: Docker (Recommended)
+
+```bash
+git clone https://github.com/flyingrobots/git-cms.git
+cd git-cms
+npm run setup
+npm run dev
+```
+
+Open the UI at [http://localhost:4638/](http://localhost:4638/).
+
+---
+
+## First Article
+
+1. Click `+ New Article`.
+2. Set a slug like `my-first-post`.
+3. Add title + body content.
+4. Click `Save Draft`.
+5. Click `Publish` when ready.
+
+---
+
+## CLI Basics
+
+```bash
+# Draft reads content from stdin
+echo "# Hello" | git cms draft hello-world "Hello World"
+
+# List drafts
+git cms list
+
+# Publish
+git cms publish hello-world
+
+# Show article
+git cms show hello-world
+```
+
+---
+
+## Safety Notes
+
+- Prefer Docker workflows while learning.
+- Use a dedicated test repository for local CLI experimentation.
+- Avoid running low-level Git plumbing in repositories you care about.
+
+See [`TESTING_GUIDE.md`](TESTING_GUIDE.md) for safety and cleanup procedures.