@otalan/cli 1.0.5 → 1.0.7

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to `@otalan/cli` will be documented in this file.
 
+## 1.0.7 - 2026-05-06
+
+### Changed
+
+- Clean public README examples to avoid project-specific app IDs, generated-looking slugs, and local development API URLs.
+- Keep user-facing login guidance pointed at the public Otalan API keys page.
+
+## 1.0.6 - 2026-05-05
+
+### Changed
+
+- Improve README CI setup examples, generated output guidance, publish rollout examples, and maintainer release checklist.
+- Add release metadata test coverage to keep package version and changelog entries in sync.
+
+## 1.0.5 - 2026-05-04
+
+### Changed
+
+- Update npm package homepage metadata.
+
 ## 1.0.4 - 2026-05-04
 
 ### Added

package/README.md

@@ -116,6 +116,7 @@ Optional:
 
 ```bash
 bun install --frozen-lockfile
+bun add -g @otalan/cli
 bun run build
 otalan login --api-key "$OTALAN_API_KEY" --api-url "${OTALAN_API_URL:-https://api.otalan.com}"
 otalan init --app-id "$OTALAN_APP_ID"
@@ -129,6 +130,7 @@ Use your normal app build command before `otalan bundle`. The CLI then packages
 
 ```bash
 bun install --frozen-lockfile
+bun add -g @otalan/cli
 otalan login --api-key "$OTALAN_API_KEY" --api-url "${OTALAN_API_URL:-https://api.otalan.com}"
 otalan init --app-id "$OTALAN_APP_ID"
 otalan bundle --target expo --platform ios --bundle-from-package
@@ -204,8 +206,8 @@ Example project config:
 
 ```json
 {
-  "organizationSlug": "test-org-407b69f7",
-  "projectSlug": "test-project-ca3bcb8a",
+  "organizationSlug": "example-organization",
+  "projectSlug": "example-project",
   "appId": "com.example.app"
 }
 ```
@@ -225,6 +227,7 @@ Prints the installed CLI version.
 ```bash
 otalan version
 otalan --version
+otalan -v
 ```
 
 ### `otalan login`
@@ -235,12 +238,6 @@ Saves the CI key and API base URL locally.
 otalan login --api-key otalan_ci_xxx --api-url https://api.otalan.com
 ```
 
-Local development:
-
-```bash
-otalan login --api-key otalan_ci_xxx --api-url http://localhost:8787
-```
-
 ### `otalan doctor`
 
 Checks API connectivity and prints the organization/project context resolved from the configured CI key.
@@ -265,13 +262,15 @@ If you already ran `otalan login`, the CLI resolves `organizationSlug` and `proj
 
 ```bash
 otalan init \
-  --app-id app.cryptosan.app
+  --app-id com.example.app
 ```
 
 ### `otalan bundle`
 
 Builds `.otalan/bundle/bundle.zip` and `.otalan/bundle/manifest.json`.
 
+`.otalan/` is generated output. Add it to your app repo's `.gitignore`; `otalan publish` reads the bundle files from the current CI workspace after `otalan bundle` runs.
+
 Capacitor:
 
 ```bash
@@ -324,6 +323,7 @@ If you want to take the bundle ID from `package.json` instead:
 
 ```bash
 otalan bundle --target capacitor --platform ios --bundle-from-package
+otalan bundle --target expo --platform ios --bundle-from-package
 ```
 
 ### `otalan publish`
@@ -335,8 +335,13 @@ Publishes the current bundle output with rollout metadata.
 Current behavior:
 
 - `channel` is chosen at publish time
+- publishes are mandatory by default
+- default rollout is `100`
 - `--platform` and `--native-version` can override the manifest, but only if they match it
 - `--output-dir` lets you publish a bundle from a non-default folder
+- `--rollout-percent` accepts an integer from `0` to `100`
+- `--optional` marks the update as non-mandatory
+- `--release-notes` attaches release notes to the published bundle
 - Expo publish forwards the stored Expo app config when present
 - Otalan validates the release ZIP before the publish completes
 
@@ -346,6 +351,18 @@ Default flow:
 otalan publish --channel production
 ```
 
+Staged rollout:
+
+```bash
+otalan publish --channel production --rollout-percent 25 --release-notes "Fix startup crash"
+```
+
+Optional update:
+
+```bash
+otalan publish --channel production --optional
+```
+
 This uses `POST /v1/releases/create` and waits for `GET /v1/releases/ingests/:id` to reach `ready` before returning success.
 
 If validation fails, `otalan publish` exits non-zero and prints the ingest failure reason when the API provides one. This makes the command safe to use directly in CI/CD pipelines.
@@ -427,6 +444,10 @@ otalan status --platform ios --channel production
 
 Before publishing a public package release:
 
+- update `package.json` to the new package version
+- add the matching `CHANGELOG.md` entry
+- run the release checks and inspect the package dry run
+
 ```bash
 bun install --frozen-lockfile
 bun test
@@ -443,6 +464,5 @@ bun pm pack --dry-run
 - This is a Bun-based CLI published on npm.
 - Expo / React Native bundling uses `bunx expo ...`.
 - Default API URL is `https://api.otalan.com`.
-- Local development API URL is `http://localhost:8787`.
 - Publishing, rollback, status, and `bundles` expect a CI key and an active app.
 - Run `bun run build` after changing CLI source if you want `dist/bin.js` updated locally.