Merge pull request 'chore: rebranding cleanup — reset versions to 0.1.0, bun→pnpm in docs' (#64) from chore/rebranding-cleanup into main
CI / check (push) Successful in 3m5s
CI / check (push) Successful in 3m5s
chore: rebranding cleanup — reset versions to 0.1.0, bun→pnpm in docs (#64)
This commit was merged in pull request #64.
This commit is contained in:
@@ -222,41 +222,42 @@ Test files (`__tests__/**`) are exempt.
|
|||||||
|
|
||||||
| Tool | Purpose |
|
| Tool | Purpose |
|
||||||
|------|---------|
|
|------|---------|
|
||||||
| **bun** | Package manager + runtime |
|
| **pnpm** | Package manager |
|
||||||
| **TypeScript** | Type checking (strict mode) |
|
| **TypeScript** | Type checking (strict mode) |
|
||||||
| **Biome** | Lint + format (replaces ESLint + Prettier) |
|
| **Biome** | Lint + format (replaces ESLint + Prettier) |
|
||||||
| **vitest** | Test runner (`cli` uses vitest; other packages use `bun test`) |
|
| **vitest** | Test runner (all packages) |
|
||||||
|
|
||||||
### Development Workflow
|
### Development Workflow
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# ── Setup ──
|
# ── Setup ──
|
||||||
bun install # install all workspace dependencies
|
pnpm install # install all workspace dependencies
|
||||||
|
|
||||||
# ── Daily development ──
|
# ── Daily development ──
|
||||||
bun run build # tsc --build (all packages, dependency order)
|
pnpm run build # build all packages (dependency order)
|
||||||
bun run check # tsc --build + biome check + lint-log-tags
|
pnpm run check # biome check + lint-log-tags
|
||||||
bun run format # biome format --write
|
pnpm run typecheck # tsc --build
|
||||||
bun test # run tests across all packages
|
pnpm run test # run tests across all packages
|
||||||
|
|
||||||
# ── Before committing ──
|
# ── Before committing ──
|
||||||
bun run check # must pass — typecheck + lint + log tag validation
|
pnpm run check # must pass — lint + log tag validation
|
||||||
bun test # must pass — all package tests
|
pnpm run typecheck # must pass — type checking
|
||||||
|
pnpm run test # must pass — all package tests
|
||||||
```
|
```
|
||||||
|
|
||||||
### Publishing
|
### Publishing
|
||||||
|
|
||||||
All public `@united-workforce/*` packages are published to **npmjs.org** with **fixed mode** (all packages share the same version number).
|
All public `@united-workforce/*` packages are published to **npmjs.org** with **independent versioning**.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 1. Add a changeset describing the change
|
# 1. Add a changeset describing the change
|
||||||
bun changeset
|
npx changeset
|
||||||
|
|
||||||
# 2. Bump all package versions + generate CHANGELOGs
|
# 2. Bump versions + generate CHANGELOGs
|
||||||
bun version
|
proman bump
|
||||||
|
|
||||||
# 3. Build, test, and publish (runs scripts/publish-all.mjs)
|
# 3. Build, test, and publish
|
||||||
bun release
|
proman publish
|
||||||
|
|
||||||
# Or publish manually with a tag:
|
# Or publish manually with a tag:
|
||||||
node scripts/publish-all.mjs --tag alpha
|
node scripts/publish-all.mjs --tag alpha
|
||||||
|
|||||||
@@ -470,7 +470,7 @@ Use the `ocas` CLI for direct CAS operations (`~/.ocas/` store, shared with `uwf
|
|||||||
|
|
||||||
| Tool | Purpose |
|
| Tool | Purpose |
|
||||||
|------|---------|
|
|------|---------|
|
||||||
| **bun** | Package manager + runtime |
|
| **pnpm** | Package manager |
|
||||||
| **TypeScript** | Type checking (strict mode) |
|
| **TypeScript** | Type checking (strict mode) |
|
||||||
| **Biome** | Lint + format |
|
| **Biome** | Lint + format |
|
||||||
| **vitest** | Test runner |
|
| **vitest** | Test runner |
|
||||||
|
|||||||
+3
-3
@@ -17,7 +17,7 @@ The root README should have these sections in order:
|
|||||||
4. **Packages** — table with ALL packages from packages/ directory, columns: Package, Description, Type (cli/lib/agent/app)
|
4. **Packages** — table with ALL packages from packages/ directory, columns: Package, Description, Type (cli/lib/agent/app)
|
||||||
5. **Quick Start** — install, build, register workflow, start thread, run step
|
5. **Quick Start** — install, build, register workflow, start thread, run step
|
||||||
6. **CLI Reference** — brief command list, detailed usage in cli README
|
6. **CLI Reference** — brief command list, detailed usage in cli README
|
||||||
7. **Development** — bun install / build / check / test
|
7. **Development** — pnpm install / build / check / test
|
||||||
|
|
||||||
## Per-Package README Structure
|
## Per-Package README Structure
|
||||||
|
|
||||||
@@ -26,7 +26,7 @@ Each package README should have:
|
|||||||
1. **Title** — package name
|
1. **Title** — package name
|
||||||
2. **One-line description** — matching package.json
|
2. **One-line description** — matching package.json
|
||||||
3. **Overview** — what it does, where it sits in the architecture, dependencies
|
3. **Overview** — what it does, where it sits in the architecture, dependencies
|
||||||
4. **Installation** — bun add (for libs) or "included as binary" (for cli/agents)
|
4. **Installation** — pnpm add (for libs) or "included as binary" (for cli/agents)
|
||||||
5. **API** (lib packages) — all exports from src/index.ts with type signatures, grouped by category, minimal usage examples
|
5. **API** (lib packages) — all exports from src/index.ts with type signatures, grouped by category, minimal usage examples
|
||||||
6. **CLI Usage** (cli/agent packages) — command reference with examples
|
6. **CLI Usage** (cli/agent packages) — command reference with examples
|
||||||
7. **Internal Structure** — brief src/ file organization
|
7. **Internal Structure** — brief src/ file organization
|
||||||
@@ -56,7 +56,7 @@ For each package read:
|
|||||||
- All relative links work
|
- All relative links work
|
||||||
- Package names match package.json
|
- Package names match package.json
|
||||||
- No references to removed/renamed packages
|
- No references to removed/renamed packages
|
||||||
- bun run build still passes
|
- pnpm run build still passes
|
||||||
|
|
||||||
## Guidelines
|
## Guidelines
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/agent-builtin",
|
"name": "@united-workforce/agent-builtin",
|
||||||
"version": "0.5.0",
|
"version": "0.1.0",
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"src",
|
||||||
"dist",
|
"dist",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/agent-hermes",
|
"name": "@united-workforce/agent-hermes",
|
||||||
"version": "0.5.0",
|
"version": "0.1.0",
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"src",
|
||||||
"dist",
|
"dist",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/agent-mock",
|
"name": "@united-workforce/agent-mock",
|
||||||
"version": "0.5.0",
|
"version": "0.1.0",
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"src",
|
||||||
"dist",
|
"dist",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/cli",
|
"name": "@united-workforce/cli",
|
||||||
"version": "0.5.0",
|
"version": "0.1.0",
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"src",
|
||||||
"dist",
|
"dist",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/dashboard",
|
"name": "@united-workforce/dashboard",
|
||||||
"version": "0.5.0-alpha.4",
|
"version": "0.1.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/protocol",
|
"name": "@united-workforce/protocol",
|
||||||
"version": "0.5.0",
|
"version": "0.1.0",
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"src",
|
||||||
"dist",
|
"dist",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/util-agent",
|
"name": "@united-workforce/util-agent",
|
||||||
"version": "0.5.0",
|
"version": "0.1.0",
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"src",
|
||||||
"dist",
|
"dist",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@united-workforce/util",
|
"name": "@united-workforce/util",
|
||||||
"version": "0.5.0",
|
"version": "0.1.0",
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"src",
|
||||||
"dist",
|
"dist",
|
||||||
|
|||||||
Reference in New Issue
Block a user