Skip to content

Commit aa4dc7c

Browse files
authored
chore: hide emulator commands and restore stable versioning (#114)
The emulator (workos emulate, workos dev) is not ready for GA. Hide both commands from help output and README while keeping them functional for internal testing. Switch release-please back to stable versioning so the next release ships as 0.12.0.
1 parent f2a6ec2 commit aa4dc7c

5 files changed

Lines changed: 11 additions & 33 deletions

File tree

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "0.12.0-beta.1"
2+
".": "0.12.0"
33
}

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,6 @@ Resource Management:
7777
api-key Manage per-org API keys
7878
org-domain Manage organization domains
7979

80-
Local Development:
81-
emulate Start a local WorkOS API emulator
82-
dev Start emulator + your app in one command
83-
8480
Workflows:
8581
seed Declarative resource provisioning from YAML
8682
setup-org One-shot organization onboarding
@@ -196,6 +192,10 @@ Inspects a directory's sync state, user/group counts, recent events, and detects
196192
workos debug-sync directory_01ABC123
197193
```
198194

195+
<!-- UNRELEASED: Local Development (emulator) — hidden until beta testing is complete.
196+
To restore, uncomment this section and re-enable the `emulate` and `dev` commands
197+
in src/bin.ts and src/utils/help-json.ts.
198+
199199
### Local Development
200200

201201
Test your WorkOS integration locally without hitting the live API. The emulator provides a full in-memory WorkOS API replacement with all major endpoints.
@@ -348,6 +348,8 @@ The emulator covers the full WorkOS API surface (~84% of OpenAPI spec endpoints)
348348

349349
JWT tokens include `role` and `permissions` claims for org-scoped sessions. All list endpoints support cursor pagination (`before`, `after`, `limit`, `order`). Error responses match the WorkOS format (`{ message, code, errors }`).
350350

351+
END UNRELEASED -->
352+
351353
### Environment Management
352354

353355
```bash

release-please-config.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
"release-type": "node",
77
"bump-minor-pre-major": true,
88
"changelog-path": "CHANGELOG.md",
9-
"versioning": "prerelease",
10-
"prerelease": true,
11-
"prerelease-type": "beta"
9+
"versioning": "default"
1210
}
1311
}
1412
}

src/bin.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2130,7 +2130,7 @@ yargs(rawArgs)
21302130
)
21312131
.command(
21322132
'emulate',
2133-
'Start a local WorkOS API emulator',
2133+
false, // Hidden: unreleased beta feature
21342134
(yargs) =>
21352135
yargs.options({
21362136
port: { type: 'number', default: 4100, describe: 'Port to listen on' },
@@ -2143,7 +2143,7 @@ yargs(rawArgs)
21432143
)
21442144
.command(
21452145
'dev',
2146-
'Start emulator + your app in one command',
2146+
false, // Hidden: unreleased beta feature
21472147
(yargs) =>
21482148
yargs.options({
21492149
port: { type: 'number', default: 4100, describe: 'Emulator port' },

src/utils/help-json.ts

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1048,29 +1048,7 @@ const commands: CommandSchema[] = [
10481048
},
10491049
],
10501050
},
1051-
// --- Emulator ---
1052-
{
1053-
name: 'emulate',
1054-
description: 'Start a local WorkOS API emulator',
1055-
options: [
1056-
{ name: 'port', type: 'number', description: 'Port to listen on', required: false, default: 4100, hidden: false },
1057-
{
1058-
name: 'seed',
1059-
type: 'string',
1060-
description: 'Path to seed config file (YAML or JSON)',
1061-
required: false,
1062-
hidden: false,
1063-
},
1064-
],
1065-
},
1066-
{
1067-
name: 'dev',
1068-
description: 'Start emulator + your app in one command',
1069-
options: [
1070-
{ name: 'port', type: 'number', description: 'Emulator port', required: false, default: 4100, hidden: false },
1071-
{ name: 'seed', type: 'string', description: 'Path to seed config file', required: false, hidden: false },
1072-
],
1073-
},
1051+
// --- Emulator (hidden: unreleased beta feature) ---
10741052
// --- Workflow Commands ---
10751053
{
10761054
name: 'seed',

0 commit comments

Comments
 (0)