Skip to content

Commit db04f65

Browse files
committed
Document release workflow in CLAUDE.md
1 parent 954d5c8 commit db04f65

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Completo - All the Toppings. None of the Mess.
22

3-
> **About this file:** CLAUDE.md is for agent guidance architectural decisions, rules, conventions, and gotchas that can't be inferred from reading code. Don't bloat it with code-level details (file listings, prop docs, full API specs) that agents can discover by reading the source. Focus on the "why", not the "what".
3+
> **About this file:** CLAUDE.md is for agent guidance - architectural decisions, rules, conventions, and gotchas that can't be inferred from reading code. Don't bloat it with code-level details (file listings, prop docs, full API specs) that agents can discover by reading the source. Focus on the "why", not the "what".
44
55
Kanban board app. Nuxt 4 + Nuxt UI 4 + Tailwind 4 + Drizzle ORM + SQLite. Plus Jakarta Sans + JetBrains Mono. Lucide icons (`i-lucide-*`). pnpm.
66

@@ -105,6 +105,16 @@ npx drizzle-kit push # Dev only — diffs schema against DB
105105
npx drizzle-kit generate # Generate migration SQL from schema changes
106106
```
107107

108+
### Releasing
109+
110+
**Before tagging a release:** bump `version` in `package.json`, update `README.md` with any user-facing changes, and commit those changes.
111+
112+
**To release:** `git tag vX.Y.Z && git push origin vX.Y.Z`. The tag push triggers two workflows:
113+
- **CI** (`ci.yml`) — runs lint + tests against the tag.
114+
- **Release** (`release.yml`) — builds multi-arch Docker image (`linux/amd64` + `linux/arm64`), pushes to GHCR (`ghcr.io/scalecommerce-dev/completo`), and creates a GitHub Release with auto-generated notes.
115+
116+
**To re-tag** (e.g. after a fix): delete the GitHub release (`gh release delete vX.Y.Z --yes`), delete remote + local tag (`git push origin --delete vX.Y.Z && git tag -d vX.Y.Z`), then re-tag and push.
117+
108118
### Schema Changes & Migrations
109119

110120
`drizzle-kit push` = dev (no migration files). `pnpm db:migrate` = production (applies SQL from `server/database/migrations/`).

0 commit comments

Comments
 (0)