Skip to content

Commit 4a3e8ab

Browse files
committed
docs: fix 3.0 release notes before publish
Three pre-publish fixes from review of the sprint 2c–5 work: - Migration guide claimed shipnode auto-migrates the old <remotePath>/releases layout on first 3.0 deploy. No such code exists. Replace the claim with explicit manual cleanup commands (rm -rf releases current after first 3.0 deploy, or mv to preserve release history). Updated the breaking-changes table to match. - CHANGELOG described a .app(name, fn) builder method that doesn't exist. Actual API is shipnode.app() (no args) returning a ShipnodeAppBuilder, plus the standalone app() factory. Corrected the entry to describe what shipped. - Removed docs/3.0-execution-plan.md — internal working document marked for deletion at 3.0 release. 209 tests pass, tsc clean. Ready to tag and publish.
1 parent 4b69e0e commit 4a3e8ab

3 files changed

Lines changed: 34 additions & 339 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ All notable changes to `@devalade/shipnode` will be documented here.
66

77
### Added
88
- **Multi-app workspaces** — a single `shipnode.config.ts` can now declare multiple applications deployed to the same server, each with its own domain, PM2 process set, health check, env file, build steps, and hooks:
9-
- New `.app(name, fn)` builder method to define per-app configuration inside a workspace.
10-
- New `.apps([api, web])` builder method to compose multiple apps into one deployment.
9+
- New `shipnode.app()` (and the standalone `app()` factory exported from the package) returns a per-app sub-builder with the per-app methods (`.backend()`/`.frontend()`, `.name()`, `.appRoot()`, `.domain()`, `.port()`, `.pm2()`, `.worker()`, `.envFile()`, `.healthCheck()`, `.preDeploy()`/`.postDeploy()`, etc.).
10+
- New `.apps([api, web])` builder method on the workspace builder to compose multiple apps into one deployment.
1111
- Each app gets its own release directory (`<remotePath>/<app-name>/releases/<ts>/`), own Caddy site block, own PM2 ecosystem, and own lock file.
1212
- Orchestrator iterates over all apps, selecting the right strategy per-app (backend/frontend).
1313
- **`--app <name>` CLI flag** — target a single app in a multi-app workspace (`shipnode deploy --app api`, `shipnode logs --app web`). Commands without `--app` apply to all apps. `rollback` requires `--app`.

0 commit comments

Comments
 (0)