@uipath/vertical-solutions-tool 1.204.0-preview.254 → 1.205.0-preview.256

package/README.md

@@ -36,8 +36,88 @@ Generate types for your vertical solution
 uip vss generate
 ```
 
+## Deploy
+
+Full reference: [`docs/tools/vertical-solutions.md`](../../docs/tools/vertical-solutions.md).
+
+### `uip vss deploy`
+
+Submit a Vertical Solution deploy job and watch it. The deploy runs in UiPath
+Cloud **as you**, with your permissions. The CLI submits, streams the job's
+logs, and lets you resume or cancel it.
+
+```bash
+# Guided — pick vertical, package, version, folder and name; then confirm
+uip vss deploy
+
+# Narrow a step by passing its flag; the rest still prompt
+uip vss deploy --vertical fins
+
+# Pass them all and nothing prompts — this is the CI/CD shape
+uip vss deploy \
+  --package-name fins.loan-setup --package-version 1.4.2 \
+  --folder-path "Shared/Lending-Prod" --deployment-name lending-prod \
+  --config apiToken=env.LOAN_API_TOKEN --yes
+```
+
+Prompting happens only when stdout and stdin are both TTYs, unless the host's
+global `--interactive` turns it on regardless. In a pipeline a missing input
+is a structured failure naming the flag to pass, never a hang.
+
+### `uip vss deploy status|resume|cancel <job-id>`
+
+Once the service accepts a deploy job it is never rerun on its own, so
+recovery is always explicit. A submit the service refuses for capacity is
+retried before the job exists.
+
+```bash
+uip vss deploy status <job-id>          # read-only; safe to poll from CI
+uip vss deploy resume <job-id>          # from the last checkpoint, or attach
+uip vss deploy cancel <job-id> --yes
+```
+
+`resume` covers the three ways a deploy stops. The first is a pause, for
+activation setup, connection authorization, the portal's configuration wizard,
+or an expired login (run `uip login` first). The second is a failed step. The
+third is a job interrupted mid-deploy. It also re-attaches after Ctrl-C, which ends the
+watch and leaves the job running. A resumed job that succeeds gets the same
+aftercare as a fresh deploy — for a package that declares seed entities, the
+seed context, templates and the seeding offer — so `--seed` / `--no-seed` /
+`--yes` work on `resume` too. That applies to a resume that watches the job:
+`resume --no-wait` returns once the job is accepted, so check it with
+`deploy status` and seed with `deploy seed` afterwards.
+
+### `uip vss deploy seed`
+
+Load Data Fabric records from the seed workspace that a successful watched
+deploy writes (`./seeding/<package-name>/`) when the package declares seed
+entities. A `--no-wait` deploy writes none. Pass `--package-name` and
+`--package-version` to `deploy seed` to create it. Re-running is safe: the
+`.seed-ids.json` journal records what an earlier run inserted, so a seed that
+died halfway matches those rows instead of inserting them twice. Under the
+`upsert` strategy, the seed also updates them. The default `insert` strategy
+leaves them alone.
+
+```bash
+uip vss deploy seed --yes
+```
+
+## Not supported here
+
+`uip vss deploy` does not provision tenant-level resources. A package whose
+manifest declares an entity schema (`dataFabric.schemaFilename`), an IXP
+project, a web application, or tenant-level storage buckets or indexes is
+refused before a job is created, naming exactly what would go unprovisioned.
+Deploying such packages with the CLI is not supported yet.
+
 ## Changes
 
+### vss 1.x
+
+- `deploy`, `deploy seed`, `deploy status`, `deploy resume` and `deploy cancel`:
+  deploy a Vertical Solution and seed its Data Fabric data, guided at a
+  terminal and driveable entirely from flags for CI/CD.
+
 ### vss 0.0.1
 
 - Initial release with `init`, `sync`, `add`, and `generate` commands