Update CLAUDE.md and README.md to reflect current architecture

hubyrod · claude · hubyrod · commit 4d6f1b3d967c · 2026-02-27T14:41:01.000+01:00
Replace generic Bun template in CLAUDE.md with project-specific guidance
covering architecture, commands, and config system. Update README config
example to show group-based and direct stream routes, add issue_comment
to supported events, and fix env var references.

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -1,106 +1,75 @@
+# CLAUDE.md
 
-Default to using Bun instead of Node.js.
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
 
-- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
-- Use `bun test` instead of `jest` or `vitest`
-- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
-- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
-- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
-- Use `bunx <package> <command>` instead of `npx <package> <command>`
-- Bun automatically loads .env, so don't use dotenv.
+## What This Is
 
-## APIs
+Skiphooks is a GitHub webhook server that forwards repository events (PRs, issues, pushes, releases, comments) to Slashwork streams via GraphQL. Built with Bun — no Node.js, no Express, no runtime dependencies.
 
-- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
-- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
-- `Bun.redis` for Redis. Don't use `ioredis`.
-- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
-- `WebSocket` is built-in. Don't use `ws`.
-- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
-- Bun.$`ls` instead of execa.
+## Commands
 
-## Testing
+```sh
+bun install          # Install dependencies
+bun run dev          # Dev server with --watch
+bun run start        # Production server
+bun test             # Run all tests
+bun test --filter "handler"  # Run specific tests
+bunx tsc --noEmit    # Type-check without emitting
+./test-webhook.sh skipper     # Send test webhook to a route
+./test-webhook.sh skjs http://localhost:3000  # Custom base URL
+```
 
-Use `bun test` to run tests.
+## Bun Rules
 
-```ts#index.test.ts
-import { test, expect } from "bun:test";
+Default to Bun for everything. Bun auto-loads `.env` — don't use dotenv.
 
-test("hello world", () => {
-  expect(1).toBe(1);
-});
-```
+- `Bun.serve()` for HTTP — don't use Express
+- `bun:test` for testing — don't use Jest/Vitest
+- `Bun.file` over `node:fs` readFile/writeFile
+- `bun install` / `bun run` / `bunx` — not npm/yarn/npx
 
-## Frontend
-
-Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
-
-Server:
-
-```ts#index.ts
-import index from "./index.html"
-
-Bun.serve({
-  routes: {
-    "/": index,
-    "/api/users/:id": {
-      GET: (req) => {
-        return new Response(JSON.stringify({ id: req.params.id }));
-      },
-    },
-  },
-  // optional websocket support
-  websocket: {
-    open: (ws) => {
-      ws.send("Hello, world!");
-    },
-    message: (ws, message) => {
-      ws.send(message);
-    },
-    close: (ws) => {
-      // handle close
-    }
-  },
-  development: {
-    hmr: true,
-    console: true,
-  }
-})
-```
+## Architecture
 
-HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
+**Request flow:** `Bun.serve() → route match → signature verify → handler dispatch → format markdown → GraphQL post`
 
-```html#index.html
-<html>
-  <body>
-    <h1>Hello, world!</h1>
-    <script type="module" src="./frontend.tsx"></script>
-  </body>
-</html>
-```
+### Entry point: `src/index.ts`
 
-With the following `frontend.tsx`:
+`Bun.serve()` matches URLs via regex `/github/<route-name>`. Routes are defined in root `config.ts`. On each request: verify HMAC-SHA256 signature, look up handler by `x-github-event` header, check action relevance, format to markdown, POST to Slashwork GraphQL.
 
-```tsx#frontend.tsx
-import React from "react";
-import { createRoot } from "react-dom/client";
+### Config: root `config.ts` + `src/config.ts`
 
-// import .css files directly and it works
-import './index.css';
+Two-level config system:
+- **`src/config.ts`** — types (`SkiphooksConfig`, `GroupConfig`, `RouteConfig`) and `loadConfig()` with validation
+- **Root `config.ts`** — runtime config instance with actual values
 
-const root = createRoot(document.body);
+Routes support two modes:
+- **Group-based:** `{ group: "skipper" }` — references a named group in `config.groups` that provides `id` and `authToken`
+- **Direct stream:** `{ streamId: "...", authToken: "..." }` — standalone stream config
 
-export default function Frontend() {
-  return <h1>Hello, world!</h1>;
-}
+### Handlers: `src/handlers/`
 
-root.render(<Frontend />);
-```
+Each handler implements `EventHandler` interface (`types.ts`):
+- `isRelevantAction(action?)` — filters which GitHub actions to process
+- `format(payload)` — returns `{ markdown: string }` for Slashwork
 
-Then, run index.ts
+Handlers: `pull-request.ts`, `issues.ts`, `issue-comment.ts`, `push.ts`, `release.ts`
 
-```sh
-bun --hot ./index.ts
-```
+### Slashwork client: `src/slashwork.ts`
+
+GraphQL client with Bearer token auth. `postToSlashwork()` sends formatted markdown to a target stream/group. `validateConnection()` checks auth on startup.
+
+### Webhook verification: `src/webhook.ts`
+
+HMAC-SHA256 signature verification using `node:crypto`. Compares `x-hub-signature-256` header against computed hash.
+
+## Environment Variables
+
+See `.env.example`. Key vars:
+- `GITHUB_WEBHOOK_SECRET` — shared secret for webhook signature verification
+- `SLASHWORK_GRAPHQL_URL` — GraphQL endpoint
+- `SLASHWORK_AUTH_TOKEN_SKIPPER` / `SLASHWORK_AUTH_TOKEN_SKJS` — per-group auth tokens
+- `PORT` — server port (default 3000)
+
+## Deployment
 
-For more information, read the Bun API docs in `node_modules/bun-types/docs/**.mdx`.
+Clever Cloud via GitHub Actions. Push to `main` → typecheck + tests → auto-deploy.
diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@ A GitHub webhook server that posts repository events to Slashwork via their Grap
 |---|---|
 | `pull_request` | opened, closed/merged, review_requested, ready_for_review, synchronize |
 | `issues` | opened, closed, reopened, labeled, assigned |
+| `issue_comment` | created |
 | `push` | all pushes (no action filter) |
 | `release` | published, created, edited |
 
@@ -35,7 +36,7 @@ cp .env.example .env
 
 ## Configuration
 
-Event routing is configured in `config.ts` at the project root. Each event type maps to a Slashwork group ID:
+Event routing is configured in `config.ts` at the project root:
 
 ```ts
 import type { SkiphooksConfig } from "./src/config.ts";
@@ -46,11 +47,21 @@ const config: SkiphooksConfig = {
   },
   slashwork: {
     graphqlUrl: process.env.SLASHWORK_GRAPHQL_URL!,
-    authToken: process.env.SLASHWORK_AUTH_TOKEN!,
+  },
+  groups: {
+    myproject: {
+      id: "g_abc123",
+      authToken: process.env.SLASHWORK_AUTH_TOKEN_MYPROJECT!,
+    },
   },
   routes: {
-    "my-project": { groupId: "group-abc-123" },
-    "releases":   { groupId: "group-def-456" },
+    // Group-based route — references a named group for its ID and auth token
+    myproject: { group: "myproject" },
+    // Direct stream route — specifies stream ID and auth token inline
+    releases: {
+      streamId: "g_def456",
+      authToken: process.env.SLASHWORK_AUTH_TOKEN_RELEASES!,
+    },
   },
 };
 
@@ -59,14 +70,15 @@ export default config;
 
 - **Secrets** stay in `.env` and are referenced via `process.env`.
 - **Routes** are path-based — each route name becomes a `/github/<name>` endpoint. Only configured routes are active — requests to unknown routes return 404.
+- **Groups** let multiple routes share the same auth token and target ID. Routes can reference a group by name or specify `streamId`/`authToken` directly.
 
 ## Slashwork Configuration
 
 See the [Slashwork Developer docs](https://slashwork.com/developer) for full details.
 
 1. Create a **stream** (or use an existing one) where notifications will be posted.
-2. Create an **application** with a dedicated auth token — this goes in `SLASHWORK_AUTH_TOKEN`.
-3. Find the **group ID** of your target stream(s) from their URLs — these go in `config.ts` routes.
+2. Create an **application** with a dedicated auth token — this goes in a `SLASHWORK_AUTH_TOKEN_*` env var.
+3. Find the **group ID** of your target stream(s) from their URLs — these go in `config.ts` groups or routes.
 4. Set `SLASHWORK_GRAPHQL_URL` to `https://<your-instance>.slashwork.com/api/graphql`.
 
 ## GitHub Webhook Setup
@@ -109,6 +121,6 @@ Deployed to [Clever Cloud](https://clever-cloud.com) via GitHub Actions. Every p
 
 - **Signature mismatch (401):** Ensure `GITHUB_WEBHOOK_SECRET` matches exactly between GitHub and your `.env`. Check for trailing whitespace.
 - **Posts not appearing:** Verify group IDs in `config.ts` point to valid streams. Check server logs for GraphQL errors.
-- **Token issues:** Ensure `SLASHWORK_AUTH_TOKEN` has write permissions to the target groups.
+- **Token issues:** Ensure your `SLASHWORK_AUTH_TOKEN_*` env vars have write permissions to the target groups.
 - **No events received:** Confirm the webhook is active in GitHub (Settings → Webhooks) and the desired events are selected.
 - **Event ignored:** Check that the route exists in `config.ts` and the action is one of the supported actions listed above.
