Skip to content

Commit 876c9f0

Browse files
tailor-docs-bot[bot]tailor-docs-bot[bot]
committed
Update SDK pages
1 parent 6368c18 commit 876c9f0

5 files changed

Lines changed: 183 additions & 47 deletions

File tree

‎docs/sdk/cli-reference.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -313,10 +313,15 @@ Commands for managing crash reports.
313313

314314
Commands for setting up project infrastructure.
315315

316-
| Command | Description |
317-
| ----------------------------------------- | -------------------------------------------------------------------------------- |
318-
| [setup](cli/setup.md#setup) | Generate a CI deploy workflow for your project. (beta) |
319-
| [setup check](cli/setup.md#setup-check) | Audit generated workflows for drift against the current config/repo (read-only). |
316+
| Command | Description |
317+
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
318+
| [setup](cli/setup.md#setup) | Generate CI deploy workflows for your project. (beta) |
319+
| [setup action](cli/setup.md#setup-action) | Generate a per-app composite action for use with setup coordinate (monorepo multi-app deploys). |
320+
| [setup branch](cli/setup.md#setup-branch) | Generate a branch-target deploy workflow (push to branch triggers deploy). |
321+
| [setup check](cli/setup.md#setup-check) | Audit generated workflows for drift against the current config/repo (read-only). |
322+
| [setup coordinate](cli/setup.md#setup-coordinate) | Generate a coordinator workflow that orchestrates multiple --action-generated composite actions. |
323+
| [setup preview](cli/setup.md#setup-preview) | Generate a preview workflow (PR open/sync triggers deploy to a per-PR workspace). |
324+
| [setup tag](cli/setup.md#setup-tag) | Generate a tag-target deploy workflow (tag push triggers deploy). |
320325

321326
### [Upgrade Commands](cli/upgrade)
322327

‎docs/sdk/cli/setup.md‎

Lines changed: 129 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,70 @@ Commands for setting up project infrastructure.
44

55
## setup
66

7-
Generate a CI deploy workflow for your project. (beta)
7+
Generate CI deploy workflows for your project. (beta)
88

99
**Usage**
1010

1111
```
12-
tailor-sdk setup [options] [command]
12+
tailor-sdk setup <command>
13+
```
14+
15+
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
16+
17+
**Commands**
18+
19+
| Command | Description |
20+
| --------------------------------------- | ------------------------------------------------------------------------------------------------ |
21+
| [`setup branch`](#setup-branch) | Generate a branch-target deploy workflow (push to branch triggers deploy). |
22+
| [`setup tag`](#setup-tag) | Generate a tag-target deploy workflow (tag push triggers deploy). |
23+
| [`setup preview`](#setup-preview) | Generate a preview workflow (PR open/sync triggers deploy to a per-PR workspace). |
24+
| [`setup action`](#setup-action) | Generate a per-app composite action for use with setup coordinate (monorepo multi-app deploys). |
25+
| [`setup coordinate`](#setup-coordinate) | Generate a coordinator workflow that orchestrates multiple --action-generated composite actions. |
26+
| [`setup check`](#setup-check) | Audit generated workflows for drift against the current config/repo (read-only). |
27+
28+
### setup action
29+
30+
Generate a per-app composite action for use with setup coordinate (monorepo multi-app deploys).
31+
32+
**Usage**
33+
34+
```
35+
tailor-sdk setup action [options]
1336
```
1437

1538
**Options**
1639

17-
| Option | Alias | Description | Required | Default |
18-
| ----------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------- |
19-
| `--provider <PROVIDER>` | `-p` | CI provider to generate for (only 'github' is supported) | No | `"github"` |
20-
| `--workspace-name <WORKSPACE_NAME>` | `-n` | Workspace name (defaults to the config 'name') | No | - |
21-
| `--branch <BRANCH>` | - | Branch target: deploy trigger branch (defaults to the detected default branch). Tag target: tag-reachability guard branch (no guard when omitted) | No | - |
22-
| `--tag` | - | Generate a tag target (deploy on tag push) | No | `false` |
23-
| `--tag-pattern <TAG_PATTERN>` | - | Tag glob to match (requires --tag; defaults to v\*) | No | - |
24-
| `--environment <ENVIRONMENT>` | - | GitHub Environment for the plan/deploy jobs (defaults to the workspace name) | No | - |
25-
| `--no-plan` | - | Disable the plan job for a branch target (cannot be combined with --tag) | No | `false` |
26-
| `--erd-preview` | - | Add PR ERD viewer artifacts with current/diff previews for TailorDB namespaces | No | `false` |
27-
| `--dir <DIR>` | `-d` | App directory (for monorepo setups) | No | `"."` |
28-
| `--force` | - | Discard hand edits / take over unmanaged files and regenerate | No | `false` |
40+
| Option | Alias | Description | Required | Default |
41+
| ----------------------------- | ----- | --------------------------------------------------- | -------- | ------- |
42+
| `--name <NAME>` | `-n` | Name (defaults to the config 'name') | No | - |
43+
| `--dir <DIR>` | `-d` | App directory | No | `"."` |
44+
| `--environment <ENVIRONMENT>` | - | GitHub Environment (defaults to the workspace name) | No | - |
45+
| `--force` | - | Discard hand edits and regenerate | No | `false` |
2946

3047
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
3148

32-
**Commands**
49+
### setup branch
50+
51+
Generate a branch-target deploy workflow (push to branch triggers deploy).
3352

34-
| Command | Description |
35-
| ----------------------------- | -------------------------------------------------------------------------------- |
36-
| [`setup check`](#setup-check) | Audit generated workflows for drift against the current config/repo (read-only). |
53+
**Usage**
54+
55+
```
56+
tailor-sdk setup branch [options]
57+
```
58+
59+
**Options**
60+
61+
| Option | Alias | Description | Required | Default |
62+
| ----------------------------- | ----- | ------------------------------------------------------------------------------ | -------- | ------- |
63+
| `--name <NAME>` | `-n` | Name (defaults to the config 'name') | No | - |
64+
| `--branch <BRANCH>` | - | Deploy trigger branch (defaults to the detected default branch) | No | - |
65+
| `--environment <ENVIRONMENT>` | - | GitHub Environment for the plan/deploy jobs (defaults to the workspace name) | No | - |
66+
| `--erd-preview` | - | Add PR ERD viewer artifacts with current/diff previews for TailorDB namespaces | No | `false` |
67+
| `--dir <DIR>` | `-d` | App directory (for monorepo setups) | No | `"."` |
68+
| `--force` | - | Discard hand edits / take over unmanaged files and regenerate | No | `false` |
69+
70+
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
3771

3872
### setup check
3973

@@ -42,9 +76,85 @@ Audit generated workflows for drift against the current config/repo (read-only).
4276
**Usage**
4377

4478
```
45-
tailor-sdk setup check
79+
tailor-sdk setup check [options]
80+
```
81+
82+
**Options**
83+
84+
| Option | Alias | Description | Required | Default |
85+
| ------ | ----- | ------------------------------------------------------------------------------------------------ | -------- | ------- |
86+
| `--ci` | - | Run in CI mode: skip checks that are handled by the runtime (e.g. TAILOR_PLATFORM_WORKSPACE_ID). | No | `false` |
87+
88+
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
89+
90+
### setup coordinate
91+
92+
Generate a coordinator workflow that orchestrates multiple --action-generated composite actions.
93+
94+
**Usage**
95+
96+
```
97+
tailor-sdk setup coordinate [options]
98+
```
99+
100+
**Options**
101+
102+
| Option | Alias | Description | Required | Default |
103+
| ----------------------------- | ----- | --------------------------------------------------------------------------------------- | -------- | ------- |
104+
| `--name <NAME>` | `-n` | Coordinator name (used in the generated workflow file name and job names) | Yes | - |
105+
| `--action <ACTION>` | - | Composite action to include (can be specified multiple times). tailor- prefix optional. | Yes | - |
106+
| `--branch <BRANCH>` | - | Branch target: deploy trigger branch (defaults to the detected default branch) | No | - |
107+
| `--tag` | - | Generate a tag target coordinator | No | `false` |
108+
| `--environment <ENVIRONMENT>` | - | GitHub Environment for the plan/deploy jobs | No | - |
109+
| `--force` | - | Discard hand edits and regenerate | No | `false` |
110+
111+
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
112+
113+
### setup preview
114+
115+
Generate a preview workflow (PR open/sync triggers deploy to a per-PR workspace).
116+
117+
**Usage**
118+
119+
```
120+
tailor-sdk setup preview [options]
46121
```
47122

123+
**Options**
124+
125+
| Option | Alias | Description | Required | Default |
126+
| ----------------------------- | ----- | ------------------------------------------------------------------------- | -------- | ------- |
127+
| `--name <NAME>` | `-n` | Name (defaults to the config 'name') | No | - |
128+
| `--branch <BRANCH>` | - | Branch to filter PRs by (defaults to the detected default branch) | No | - |
129+
| `--region <REGION>` | - | Workspace region for preview workspace creation (e.g. us-west). Required. | Yes | - |
130+
| `--require-preview-label` | - | Deploy preview only for PRs labeled `tailor:preview` instead of all PRs. | No | `false` |
131+
| `--environment <ENVIRONMENT>` | - | GitHub Environment for the preview jobs (defaults to the workspace name) | No | - |
132+
| `--dir <DIR>` | `-d` | App directory (for monorepo setups) | No | `"."` |
133+
| `--force` | - | Discard hand edits / take over unmanaged files and regenerate | No | `false` |
134+
135+
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
136+
137+
### setup tag
138+
139+
Generate a tag-target deploy workflow (tag push triggers deploy).
140+
141+
**Usage**
142+
143+
```
144+
tailor-sdk setup tag [options]
145+
```
146+
147+
**Options**
148+
149+
| Option | Alias | Description | Required | Default |
150+
| ----------------------------- | ----- | ---------------------------------------------------------------------------- | -------- | ------- |
151+
| `--name <NAME>` | `-n` | Name (defaults to the config 'name') | No | - |
152+
| `--tag-pattern <TAG_PATTERN>` | - | Tag glob to match (defaults to v\*) | No | `"v*"` |
153+
| `--branch <BRANCH>` | - | Tag-reachability guard branch (no guard when omitted) | No | - |
154+
| `--environment <ENVIRONMENT>` | - | GitHub Environment for the plan/deploy jobs (defaults to the workspace name) | No | - |
155+
| `--dir <DIR>` | `-d` | App directory (for monorepo setups) | No | `"."` |
156+
| `--force` | - | Discard hand edits / take over unmanaged files and regenerate | No | `false` |
157+
48158
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
49159

50160
## Further reading

‎docs/sdk/runtime.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The runtime entry re-exports the following namespaces. Detailed signatures, para
7676
- `secretmanager` — secret-vault access (`getSecret`, `getSecrets`)
7777
- `authconnection` — OAuth-style connection tokens (`getConnectionToken`)
7878
- `idp` — IdP user management (`new Client({ namespace })`)
79-
- `workflow` — workflow & job control (`triggerWorkflow`, `triggerJobFunction`, `wait`, `resolve`)
79+
- `workflow` — workflow & job control (`triggerWorkflow`, `resumeWorkflow`, `triggerJobFunction`, `wait`, `resolve`)
8080
- `context` — execution context (`getInvoker`)
8181
- `file` — `tailordb.file` BLOB API (`upload`, `download`, `downloadAsBase64`, `delete`, `getMetadata`, `downloadStream`, `uploadStream`, `openDownloadStream` _(deprecated)_)
8282

0 commit comments

Comments
 (0)