@tailor-platform/sdk 1.71.0 → 1.72.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/dist/cli/index.mjs +780 -184
- package/dist/cli/index.mjs.map +1 -1
- package/dist/completion/zsh-worker.zsh +124 -25
- package/docs/cli/setup.md +129 -19
- package/docs/cli-reference.md +9 -4
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# politty-completion-version: 1
|
|
2
|
-
# politty-bin-sig:
|
|
2
|
+
# politty-bin-sig: 1782914535
|
|
3
3
|
# politty-bin-path: /home/runner/work/sdk/sdk/node_modules/.bin/tailor-sdk
|
|
4
4
|
# program: tailor-sdk
|
|
5
5
|
# shell: zsh
|
|
@@ -686,12 +686,27 @@ __tailor_sdk_worker_opt_takes_value() {
|
|
|
686
686
|
secret:delete:--profile|secret:delete:-p|secret:delete:--p) return 0 ;;
|
|
687
687
|
secret:delete:--vault-name|secret:delete:--vaultName|secret:delete:-V|secret:delete:--V) return 0 ;;
|
|
688
688
|
secret:delete:--name|secret:delete:-n|secret:delete:--n) return 0 ;;
|
|
689
|
-
setup:--
|
|
690
|
-
setup:--
|
|
691
|
-
setup:--
|
|
692
|
-
setup:--
|
|
693
|
-
setup:--
|
|
694
|
-
setup:--
|
|
689
|
+
setup:branch:--name|setup:branch:-n|setup:branch:--n) return 0 ;;
|
|
690
|
+
setup:branch:--branch) return 0 ;;
|
|
691
|
+
setup:branch:--environment) return 0 ;;
|
|
692
|
+
setup:branch:--dir|setup:branch:-d|setup:branch:--d) return 0 ;;
|
|
693
|
+
setup:tag:--name|setup:tag:-n|setup:tag:--n) return 0 ;;
|
|
694
|
+
setup:tag:--tag-pattern|setup:tag:--tagPattern) return 0 ;;
|
|
695
|
+
setup:tag:--branch) return 0 ;;
|
|
696
|
+
setup:tag:--environment) return 0 ;;
|
|
697
|
+
setup:tag:--dir|setup:tag:-d|setup:tag:--d) return 0 ;;
|
|
698
|
+
setup:preview:--name|setup:preview:-n|setup:preview:--n) return 0 ;;
|
|
699
|
+
setup:preview:--branch) return 0 ;;
|
|
700
|
+
setup:preview:--region) return 0 ;;
|
|
701
|
+
setup:preview:--environment) return 0 ;;
|
|
702
|
+
setup:preview:--dir|setup:preview:-d|setup:preview:--d) return 0 ;;
|
|
703
|
+
setup:action:--name|setup:action:-n|setup:action:--n) return 0 ;;
|
|
704
|
+
setup:action:--dir|setup:action:-d|setup:action:--d) return 0 ;;
|
|
705
|
+
setup:action:--environment) return 0 ;;
|
|
706
|
+
setup:coordinate:--name|setup:coordinate:-n|setup:coordinate:--n) return 0 ;;
|
|
707
|
+
setup:coordinate:--action) return 0 ;;
|
|
708
|
+
setup:coordinate:--branch) return 0 ;;
|
|
709
|
+
setup:coordinate:--environment) return 0 ;;
|
|
695
710
|
show:--workspace-id|show:--workspaceId|show:-w|show:--w) return 0 ;;
|
|
696
711
|
show:--profile|show:-p|show:--p) return 0 ;;
|
|
697
712
|
show:--config|show:-c|show:--c) return 0 ;;
|
|
@@ -912,6 +927,11 @@ __tailor_sdk_worker_is_subcmd() {
|
|
|
912
927
|
secret:list) return 0 ;;
|
|
913
928
|
secret:delete) return 0 ;;
|
|
914
929
|
:secret) return 0 ;;
|
|
930
|
+
setup:branch) return 0 ;;
|
|
931
|
+
setup:tag) return 0 ;;
|
|
932
|
+
setup:preview) return 0 ;;
|
|
933
|
+
setup:action) return 0 ;;
|
|
934
|
+
setup:coordinate) return 0 ;;
|
|
915
935
|
setup:check) return 0 ;;
|
|
916
936
|
:setup) return 0 ;;
|
|
917
937
|
:show) return 0 ;;
|
|
@@ -2524,12 +2544,102 @@ __tailor_sdk_worker_complete_secret() {
|
|
|
2524
2544
|
__tailor_sdk_worker_cdescribe 'subcommands' _subs
|
|
2525
2545
|
}
|
|
2526
2546
|
|
|
2547
|
+
__tailor_sdk_worker_complete_setup_branch() {
|
|
2548
|
+
local -a _vals=()
|
|
2549
|
+
if __tailor_sdk_worker_opt_takes_value "setup:branch" "${words[CURRENT-1]}"; then return 0; fi
|
|
2550
|
+
if (( _after_dd )); then return 0; fi
|
|
2551
|
+
if [[ "${words[CURRENT]}" == -* ]]; then
|
|
2552
|
+
local -a _opts=()
|
|
2553
|
+
__tailor_sdk_worker_not_used "--name" "-n" "--n" && _opts+=("--name:Name (defaults to the config 'name')")
|
|
2554
|
+
__tailor_sdk_worker_not_used "--branch" && _opts+=("--branch:Deploy trigger branch (defaults to the detected default branch)")
|
|
2555
|
+
__tailor_sdk_worker_not_used "--environment" && _opts+=("--environment:GitHub Environment for the plan/deploy jobs (defaults to the workspace name)")
|
|
2556
|
+
__tailor_sdk_worker_not_used "--erd-preview" "--erdPreview" && _opts+=("--erd-preview:Add PR ERD viewer artifacts with current/diff previews for TailorDB namespaces")
|
|
2557
|
+
__tailor_sdk_worker_not_used "--dir" "-d" "--d" && _opts+=("--dir:App directory (for monorepo setups)")
|
|
2558
|
+
__tailor_sdk_worker_not_used "--force" && _opts+=("--force:Discard hand edits / take over unmanaged files and regenerate")
|
|
2559
|
+
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
2560
|
+
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
2561
|
+
return 0
|
|
2562
|
+
fi
|
|
2563
|
+
}
|
|
2564
|
+
|
|
2565
|
+
__tailor_sdk_worker_complete_setup_tag() {
|
|
2566
|
+
local -a _vals=()
|
|
2567
|
+
if __tailor_sdk_worker_opt_takes_value "setup:tag" "${words[CURRENT-1]}"; then return 0; fi
|
|
2568
|
+
if (( _after_dd )); then return 0; fi
|
|
2569
|
+
if [[ "${words[CURRENT]}" == -* ]]; then
|
|
2570
|
+
local -a _opts=()
|
|
2571
|
+
__tailor_sdk_worker_not_used "--name" "-n" "--n" && _opts+=("--name:Name (defaults to the config 'name')")
|
|
2572
|
+
__tailor_sdk_worker_not_used "--tag-pattern" "--tagPattern" && _opts+=("--tag-pattern:Tag glob to match (defaults to v*)")
|
|
2573
|
+
__tailor_sdk_worker_not_used "--branch" && _opts+=("--branch:Tag-reachability guard branch (no guard when omitted)")
|
|
2574
|
+
__tailor_sdk_worker_not_used "--environment" && _opts+=("--environment:GitHub Environment for the plan/deploy jobs (defaults to the workspace name)")
|
|
2575
|
+
__tailor_sdk_worker_not_used "--dir" "-d" "--d" && _opts+=("--dir:App directory (for monorepo setups)")
|
|
2576
|
+
__tailor_sdk_worker_not_used "--force" && _opts+=("--force:Discard hand edits / take over unmanaged files and regenerate")
|
|
2577
|
+
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
2578
|
+
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
2579
|
+
return 0
|
|
2580
|
+
fi
|
|
2581
|
+
}
|
|
2582
|
+
|
|
2583
|
+
__tailor_sdk_worker_complete_setup_preview() {
|
|
2584
|
+
local -a _vals=()
|
|
2585
|
+
if __tailor_sdk_worker_opt_takes_value "setup:preview" "${words[CURRENT-1]}"; then return 0; fi
|
|
2586
|
+
if (( _after_dd )); then return 0; fi
|
|
2587
|
+
if [[ "${words[CURRENT]}" == -* ]]; then
|
|
2588
|
+
local -a _opts=()
|
|
2589
|
+
__tailor_sdk_worker_not_used "--name" "-n" "--n" && _opts+=("--name:Name (defaults to the config 'name')")
|
|
2590
|
+
__tailor_sdk_worker_not_used "--branch" && _opts+=("--branch:Branch to filter PRs by (defaults to the detected default branch)")
|
|
2591
|
+
__tailor_sdk_worker_not_used "--region" && _opts+=("--region:Workspace region for preview workspace creation (e.g. us-west). Required.")
|
|
2592
|
+
__tailor_sdk_worker_not_used "--require-preview-label" "--requirePreviewLabel" && _opts+=("--require-preview-label:Deploy preview only for PRs labeled \`tailor\:preview\` instead of all PRs.")
|
|
2593
|
+
__tailor_sdk_worker_not_used "--environment" && _opts+=("--environment:GitHub Environment for the preview jobs (defaults to the workspace name)")
|
|
2594
|
+
__tailor_sdk_worker_not_used "--dir" "-d" "--d" && _opts+=("--dir:App directory (for monorepo setups)")
|
|
2595
|
+
__tailor_sdk_worker_not_used "--force" && _opts+=("--force:Discard hand edits / take over unmanaged files and regenerate")
|
|
2596
|
+
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
2597
|
+
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
2598
|
+
return 0
|
|
2599
|
+
fi
|
|
2600
|
+
}
|
|
2601
|
+
|
|
2602
|
+
__tailor_sdk_worker_complete_setup_action() {
|
|
2603
|
+
local -a _vals=()
|
|
2604
|
+
if __tailor_sdk_worker_opt_takes_value "setup:action" "${words[CURRENT-1]}"; then return 0; fi
|
|
2605
|
+
if (( _after_dd )); then return 0; fi
|
|
2606
|
+
if [[ "${words[CURRENT]}" == -* ]]; then
|
|
2607
|
+
local -a _opts=()
|
|
2608
|
+
__tailor_sdk_worker_not_used "--name" "-n" "--n" && _opts+=("--name:Name (defaults to the config 'name')")
|
|
2609
|
+
__tailor_sdk_worker_not_used "--dir" "-d" "--d" && _opts+=("--dir:App directory")
|
|
2610
|
+
__tailor_sdk_worker_not_used "--environment" && _opts+=("--environment:GitHub Environment (defaults to the workspace name)")
|
|
2611
|
+
__tailor_sdk_worker_not_used "--force" && _opts+=("--force:Discard hand edits and regenerate")
|
|
2612
|
+
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
2613
|
+
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
2614
|
+
return 0
|
|
2615
|
+
fi
|
|
2616
|
+
}
|
|
2617
|
+
|
|
2618
|
+
__tailor_sdk_worker_complete_setup_coordinate() {
|
|
2619
|
+
local -a _vals=()
|
|
2620
|
+
if __tailor_sdk_worker_opt_takes_value "setup:coordinate" "${words[CURRENT-1]}"; then return 0; fi
|
|
2621
|
+
if (( _after_dd )); then return 0; fi
|
|
2622
|
+
if [[ "${words[CURRENT]}" == -* ]]; then
|
|
2623
|
+
local -a _opts=()
|
|
2624
|
+
__tailor_sdk_worker_not_used "--name" "-n" "--n" && _opts+=("--name:Coordinator name (used in the generated workflow file name and job names)")
|
|
2625
|
+
_opts+=("--action:Composite action to include (can be specified multiple times). tailor- prefix optional.")
|
|
2626
|
+
__tailor_sdk_worker_not_used "--branch" && _opts+=("--branch:Branch target\: deploy trigger branch (defaults to the detected default branch)")
|
|
2627
|
+
__tailor_sdk_worker_not_used "--tag" && _opts+=("--tag:Generate a tag target coordinator")
|
|
2628
|
+
__tailor_sdk_worker_not_used "--environment" && _opts+=("--environment:GitHub Environment for the plan/deploy jobs")
|
|
2629
|
+
__tailor_sdk_worker_not_used "--force" && _opts+=("--force:Discard hand edits and regenerate")
|
|
2630
|
+
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
2631
|
+
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
2632
|
+
return 0
|
|
2633
|
+
fi
|
|
2634
|
+
}
|
|
2635
|
+
|
|
2527
2636
|
__tailor_sdk_worker_complete_setup_check() {
|
|
2528
2637
|
local -a _vals=()
|
|
2529
2638
|
if __tailor_sdk_worker_opt_takes_value "setup:check" "${words[CURRENT-1]}"; then return 0; fi
|
|
2530
2639
|
if (( _after_dd )); then return 0; fi
|
|
2531
2640
|
if [[ "${words[CURRENT]}" == -* ]]; then
|
|
2532
2641
|
local -a _opts=()
|
|
2642
|
+
__tailor_sdk_worker_not_used "--ci" && _opts+=("--ci:Run in CI mode\: skip checks that are handled by the runtime (e.g. TAILOR_PLATFORM_WORKSPACE_ID).")
|
|
2533
2643
|
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
2534
2644
|
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
2535
2645
|
return 0
|
|
@@ -2538,31 +2648,15 @@ __tailor_sdk_worker_complete_setup_check() {
|
|
|
2538
2648
|
|
|
2539
2649
|
__tailor_sdk_worker_complete_setup() {
|
|
2540
2650
|
local -a _vals=()
|
|
2541
|
-
case "${words[CURRENT-1]}" in
|
|
2542
|
-
--provider|-p|--p)
|
|
2543
|
-
_vals=("github")
|
|
2544
|
-
__tailor_sdk_worker_cdescribe 'completions' _vals
|
|
2545
|
-
return 0 ;;
|
|
2546
|
-
esac
|
|
2547
2651
|
if __tailor_sdk_worker_opt_takes_value "setup" "${words[CURRENT-1]}"; then return 0; fi
|
|
2548
2652
|
if (( _after_dd )); then return 0; fi
|
|
2549
2653
|
if [[ "${words[CURRENT]}" == -* ]]; then
|
|
2550
2654
|
local -a _opts=()
|
|
2551
|
-
__tailor_sdk_worker_not_used "--provider" "-p" "--p" && _opts+=("--provider:CI provider to generate for (only 'github' is supported)")
|
|
2552
|
-
__tailor_sdk_worker_not_used "--workspace-name" "--workspaceName" "-n" "--n" && _opts+=("--workspace-name:Workspace name (defaults to the config 'name')")
|
|
2553
|
-
__tailor_sdk_worker_not_used "--branch" && _opts+=("--branch:Branch target\: deploy trigger branch (defaults to the detected default branch). Tag target\: tag-reachability guard branch (no guard when omitted)")
|
|
2554
|
-
__tailor_sdk_worker_not_used "--tag" && _opts+=("--tag:Generate a tag target (deploy on tag push)")
|
|
2555
|
-
__tailor_sdk_worker_not_used "--tag-pattern" "--tagPattern" && _opts+=("--tag-pattern:Tag glob to match (requires --tag; defaults to v*)")
|
|
2556
|
-
__tailor_sdk_worker_not_used "--environment" && _opts+=("--environment:GitHub Environment for the plan/deploy jobs (defaults to the workspace name)")
|
|
2557
|
-
__tailor_sdk_worker_not_used "--no-plan" "--noPlan" && _opts+=("--no-plan:Disable the plan job for a branch target (cannot be combined with --tag)")
|
|
2558
|
-
__tailor_sdk_worker_not_used "--erd-preview" "--erdPreview" && _opts+=("--erd-preview:Add PR ERD viewer artifacts with current/diff previews for TailorDB namespaces")
|
|
2559
|
-
__tailor_sdk_worker_not_used "--dir" "-d" "--d" && _opts+=("--dir:App directory (for monorepo setups)")
|
|
2560
|
-
__tailor_sdk_worker_not_used "--force" && _opts+=("--force:Discard hand edits / take over unmanaged files and regenerate")
|
|
2561
2655
|
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
2562
2656
|
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
2563
2657
|
return 0
|
|
2564
2658
|
fi
|
|
2565
|
-
local -a _subs=("check:Audit generated workflows for drift against the current config/repo (read-only).")
|
|
2659
|
+
local -a _subs=("branch:Generate a branch-target deploy workflow (push to branch triggers deploy)." "tag:Generate a tag-target deploy workflow (tag push triggers deploy)." "preview:Generate a preview workflow (PR open/sync triggers deploy to a per-PR workspace)." "action:Generate a per-app composite action for use with setup coordinate (monorepo multi-app deploys)." "coordinate:Generate a coordinator workflow that orchestrates multiple --action-generated composite actions." "check:Audit generated workflows for drift against the current config/repo (read-only).")
|
|
2566
2660
|
__tailor_sdk_worker_cdescribe 'subcommands' _subs
|
|
2567
2661
|
}
|
|
2568
2662
|
|
|
@@ -4097,7 +4191,7 @@ __tailor_sdk_worker_complete_root() {
|
|
|
4097
4191
|
__tailor_sdk_worker_not_used "--help" && _opts+=("--help:Show help")
|
|
4098
4192
|
__tailor_sdk_worker_cdescribe 'options' _opts
|
|
4099
4193
|
else
|
|
4100
|
-
local -a _subs=("api:Call Tailor Platform API endpoints directly." "authconnection:Manage auth connections." "crashreport:Manage crash reports." "crash-report:Manage crash reports." "deploy:Deploy your application by applying the Tailor configuration." "apply:Deploy your application by applying the Tailor configuration." "executor:Manage executors" "function:Manage functions" "generate:Generate files using Tailor configuration." "init:Initialize a new project using create-sdk." "login:Login to Tailor Platform." "logout:Logout from Tailor Platform." "machineuser:Manage machine users in your Tailor Platform application." "oauth2client:Manage OAuth2 clients in your Tailor Platform application." "open:Open Tailor Platform Console." "organization:Manage Tailor Platform organizations." "profile:Manage workspace profiles (user + workspace combinations)." "query:Run SQL/GraphQL query." "remove:Remove all resources managed by the application from the workspace." "secret:Manage Secret Manager vaults and secrets." "setup:Generate
|
|
4194
|
+
local -a _subs=("api:Call Tailor Platform API endpoints directly." "authconnection:Manage auth connections." "crashreport:Manage crash reports." "crash-report:Manage crash reports." "deploy:Deploy your application by applying the Tailor configuration." "apply:Deploy your application by applying the Tailor configuration." "executor:Manage executors" "function:Manage functions" "generate:Generate files using Tailor configuration." "init:Initialize a new project using create-sdk." "login:Login to Tailor Platform." "logout:Logout from Tailor Platform." "machineuser:Manage machine users in your Tailor Platform application." "oauth2client:Manage OAuth2 clients in your Tailor Platform application." "open:Open Tailor Platform Console." "organization:Manage Tailor Platform organizations." "profile:Manage workspace profiles (user + workspace combinations)." "query:Run SQL/GraphQL query." "remove:Remove all resources managed by the application from the workspace." "secret:Manage Secret Manager vaults and secrets." "setup:Generate CI deploy workflows for your project. (beta)" "show:Show information about the deployed application." "skills:Manage Tailor SDK agent skills." "staticwebsite:Manage static websites in your workspace." "tailordb:Manage TailorDB tables and data." "upgrade:Run codemods to upgrade your project to a newer SDK version." "user:Manage Tailor Platform users." "workflow:Manage workflows and workflow executions." "workspace:Manage Tailor Platform workspaces." "completion:Generate shell completion script")
|
|
4101
4195
|
__tailor_sdk_worker_cdescribe 'subcommands' _subs
|
|
4102
4196
|
fi
|
|
4103
4197
|
}
|
|
@@ -4211,6 +4305,11 @@ _tailor_sdk_worker_completions() {
|
|
|
4211
4305
|
secret:list) __tailor_sdk_worker_complete_secret_list ;;
|
|
4212
4306
|
secret:delete) __tailor_sdk_worker_complete_secret_delete ;;
|
|
4213
4307
|
secret) __tailor_sdk_worker_complete_secret ;;
|
|
4308
|
+
setup:branch) __tailor_sdk_worker_complete_setup_branch ;;
|
|
4309
|
+
setup:tag) __tailor_sdk_worker_complete_setup_tag ;;
|
|
4310
|
+
setup:preview) __tailor_sdk_worker_complete_setup_preview ;;
|
|
4311
|
+
setup:action) __tailor_sdk_worker_complete_setup_action ;;
|
|
4312
|
+
setup:coordinate) __tailor_sdk_worker_complete_setup_coordinate ;;
|
|
4214
4313
|
setup:check) __tailor_sdk_worker_complete_setup_check ;;
|
|
4215
4314
|
setup) __tailor_sdk_worker_complete_setup ;;
|
|
4216
4315
|
show) __tailor_sdk_worker_complete_show ;;
|
package/docs/cli/setup.md
CHANGED
|
@@ -4,36 +4,70 @@ Commands for setting up project infrastructure.
|
|
|
4
4
|
|
|
5
5
|
## setup
|
|
6
6
|
|
|
7
|
-
Generate
|
|
7
|
+
Generate CI deploy workflows for your project. (beta)
|
|
8
8
|
|
|
9
9
|
**Usage**
|
|
10
10
|
|
|
11
11
|
```
|
|
12
|
-
tailor-sdk setup
|
|
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]
|
|
13
36
|
```
|
|
14
37
|
|
|
15
38
|
**Options**
|
|
16
39
|
|
|
17
|
-
| Option
|
|
18
|
-
|
|
|
19
|
-
| `--
|
|
20
|
-
| `--
|
|
21
|
-
| `--
|
|
22
|
-
| `--
|
|
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` |
|
|
29
46
|
|
|
30
47
|
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
|
|
31
48
|
|
|
32
|
-
|
|
49
|
+
### setup branch
|
|
50
|
+
|
|
51
|
+
Generate a branch-target deploy workflow (push to branch triggers deploy).
|
|
33
52
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
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.
|
|
37
71
|
|
|
38
72
|
### setup check
|
|
39
73
|
|
|
@@ -42,9 +76,85 @@ Audit generated workflows for drift against the current config/repo (read-only).
|
|
|
42
76
|
**Usage**
|
|
43
77
|
|
|
44
78
|
```
|
|
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]
|
|
46
121
|
```
|
|
47
122
|
|
|
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
|
+
|
|
48
158
|
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
|
|
49
159
|
|
|
50
160
|
## Further reading
|
package/docs/cli-reference.md
CHANGED
|
@@ -313,10 +313,15 @@ Commands for managing crash reports.
|
|
|
313
313
|
|
|
314
314
|
Commands for setting up project infrastructure.
|
|
315
315
|
|
|
316
|
-
| Command
|
|
317
|
-
|
|
|
318
|
-
| [setup](./cli/setup.md#setup)
|
|
319
|
-
| [setup
|
|
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). |
|
|
320
325
|
|
|
321
326
|
### [Upgrade Commands](./cli/upgrade.md)
|
|
322
327
|
|