Skip to content

docs(uipath-platform): expand deploy-config workflow + CLI 1.0 / solution skill sync#612

Merged
alexenica merged 7 commits intomainfrom
chore/cli-easy-wins-batch-1-skill-updates
May 7, 2026
Merged

docs(uipath-platform): expand deploy-config workflow + CLI 1.0 / solution skill sync#612
alexenica merged 7 commits intomainfrom
chore/cli-easy-wins-batch-1-skill-updates

Conversation

@alexenica
Copy link
Copy Markdown
Contributor

Summary

Three skill-doc commits batched together:

  • e447f77f — uipath-platform reflects CLI 1.0 changes (users import, deploy auto-activate, project list, --name filter)
  • 99f36a99 — solution skill sync extended to overview + agents lowcode
  • 48ed3d43 — pack-and-deploy.md: full coverage of the deploy-config workflow

The new third commit fleshes out the deploy-config workflow:

  • Documents the JSON shape (linkToResource, configuration, folderPaths, cross-resource refs).
  • Tells the agent it can edit any field directly when the CLI doesn't cover the case (nested configuration, storageBucketReference.key, custom property edits).
  • Calls out that link/unlink only modify the targeted entry — cross-references on dependents must be aligned by hand if the topology changes.

Test plan

  • pack-and-deploy.md renders correctly on GitHub
  • No broken cross-skill links (skills are independent — verified)
  • Agents reading the skill can find the Configuration Workflow section and follow the link/unlink + manual-edit guidance

🤖 Generated with Claude Code

alexenica and others added 2 commits May 7, 2026 18:49
… auto-activate, project list, --name filter

Sync the platform skill references with the recent CLI changes that
landed in PRs UiPath/cli#1365 and #1423.

* setup-environment.md — replace `users create` with `users import`.
  The old `create` / `delete` commands are gone in the CLI; users live
  in Identity Service and Orchestrator references them via the
  `AssignDirectoryUser` endpoint that backs `users import`.
* pack-and-deploy.md — `solution deploy run` now activates the
  deployment by default. Document `--skip-activate` for the legacy
  opt-out, drop the stale "polling is unreliable" warning (the CLI now
  falls back to the search service when the pipeline tracking record
  is recycled mid-poll), and update the flow diagram to show auto-
  activate plus the opt-out path.
* activate-and-manage.md — clarify that `deploy activate` is now only
  needed when `--skip-activate` was passed or when an auto-activation
  failed and the underlying cause has been fixed. Add the new
  `solution packages list --name <pattern>` server-side substring
  filter.
* develop-solution.md — add a "List Projects" section for the new
  `solution project list` command (local, no backend call); renumber
  the subsequent steps.
* triggers-and-webhooks.md — call out the new `--disabled` flag on
  `triggers create` and switch the example `--time-zone` to
  `Europe/Bucharest` so the IANA-format expectation is obvious from
  the example alone.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Make the link/unlink semantics, the JSON shape of `deploy config`, and
the path for hand-edits explicit in pack-and-deploy.md so agents know
they can edit any field directly when the CLI commands don't cover the
case (cross-resource references, nested configuration, etc.).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@alexenica alexenica force-pushed the chore/cli-easy-wins-batch-1-skill-updates branch from 48ed3d4 to a5317c1 Compare May 7, 2026 15:52
…cipes

The existing solution skill is step-by-step ("Step 1...Step N") and doesn't
cover the recurring multi-project patterns that surface in real usage —
same-name resources across cloud folders, intra-solution cross-references,
shared cloud resources, and virtual local assets at deploy time. Add a
dedicated `scenarios.md` with one section per pattern: setup, expected
behaviour, gotchas, fix, verify command.

Includes a cross-cutting failure-modes table for the common deploy errors
(`[1009] Invalid argument 'Value'`, folder collision, suffix amplification
from old CLI versions, refresh-imports-zero misconfigurations).

Linked from solution.md (Workflow References table), develop-solution.md
(Related), pack-and-deploy.md (Related), and activate-and-manage.md
(Related) so any entry path surfaces it.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
… cover the case

There's no `solution resource update` command, so users sometimes need to
hand-edit either the solution-level resource JSON or the deploy config.
Document what the SDK actually compares (`compareResourceSpecs` looks at
`resource.spec` only, excluding reference + secret fields), and split
fields into safe-to-edit (description, spec runtime config, tags,
isOverridable) vs. don't-edit (key, name, kind/type, dependencies,
runtimeDependencies, folders, files, reference fields). Same split for
deploy config — `configuration` block + `linkToResource` are hand-editable;
`resourceKey` and structural fields are not.

Emphasise this is the escape hatch, not the default. Preferred order:
SW UI round-trip → CLI (`config set`/`link`/`unlink`) → manual JSON edit.
Manual edits have no schema validation and can be silently reverted on
refresh if you touch a field bindings re-derive — surface that explicitly.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
alexenica and others added 3 commits May 7, 2026 21:04
…changes

UiPath/cli#1884 lands a few surface changes the platform skill examples
were referring to incorrectly:

- triggers enable / triggers disable subcommands have been folded into
  triggers update via --enabled / --disabled (mutually exclusive). The
  workflow walkthrough now shows the new shape and the create-disabled
  callout points at update --enabled instead of the dropped enable
  subcommand.
- triggers create no longer accepts --folder-path / --folder-key on any
  trigger type — the folder is derived from --release-key. The time and
  queue trigger examples drop the redundant flag and a one-line note
  spells out the new behavior.
- buckets list now requires either --folder-path / --folder-key or the
  new --all-folders opt-in. The "list across all accessible folders"
  example is updated to use --all-folders, with --exclude-folder-* now
  documented as cross-folder-only.
- webhooks update gains --enabled / --disabled toggles (previously the
  body hardcoded enabled: existing.enabled). Added an example.
- The --all-fields global note clarifies the new policy: orchestrator
  tool curates by default with --all-fields opt-in; resource tool
  always returns full DTO and does not expose the flag. Triggers entry
  in the OR command table reflects the dropped subcommands.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…scenario

The single 415-line scenarios.md was getting awkward to grow and was
hit by every cross-reference whether the consumer cared about a
specific scenario or the whole catalogue. Split into a folder of
six scenario files plus a thin index.

Layout:

  solution/
  ├── scenarios.md                       (index + symptom triage)
  └── scenarios/
      ├── same-name-across-folders.md
      ├── intra-solution-references.md
      ├── shared-cloud-resource.md
      ├── virtual-resource.md
      ├── manual-edits.md
      └── failure-modes.md

scenarios.md keeps its existing path so cross-references from
develop-solution.md / pack-and-deploy.md / activate-and-manage.md /
solution.md continue to resolve. It now leads with a symptom-triage
table that maps the most common error strings ("[1009] Invalid
argument", "_1 suffix", "Synced 0 resources", etc.) to the file
that explains them, then lists the six scenario files with one-line
hooks. No content changes — every scenario, gotcha, verify block,
and cross-reference moved verbatim into its own file. Internal
"see Scenario N" pointers were rewritten as same-folder relative
links.

Validated the technical claims against the current SDK and
Orchestrator code:

- addResourceWithUniqueName suffixes `_${lastNumber + 1}` —
  matches the "_1 suffix" and "stable across re-refresh"
  description.
- addOrUpdateResourceToSolutionAsync, createVirtualResourceAsync,
  compareResourceSpecs all exist and are wired the way the
  scenarios describe.
- "Synced N resources (M already in solution)" is the exact
  format emitted by resource-refresh.ts.
- ErrorCode 1009 in Orchestrator is InvalidArgument — matches
  the [1009] deploy failure scenario.
- solution deploy config has set / link / unlink subcommands.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Reflects the four follow-up improvements landed on PR #1884:

- `webhooks create` now takes the name as a **positional** argument
  (aligned with `calendars create`, `queues create`). Updated all
  examples in triggers-and-webhooks.md.
- Trigger `get/update/delete` surface a hint when `--type` defaults to
  `time` and the call returns 404 — telling the user to retry with
  `--type queue` or `--type api`. Documented inline next to the
  triggers walkthrough.
- All enum-style flags (`--method`, `--runtime-type`, `--job-priority`,
  `--priority`, `--status`, `--retention-action`, `--robot-size`) accept
  case-insensitive input now. Documented as a sibling note to the new
  type-hint guidance.
- `--all-fields` returns PascalCase keys end-to-end (was camelCase).
  Toggling the flag no longer flips casing. Clarified in
  orchestrator.md's common-flags table.

Also dropped the libraries `--all-fields` mention in resources.md —
that flag was removed in PR #1884 (libraries now return the full DTO
unconditionally, matching resource-tool convention).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@alexenica alexenica merged commit a1d659c into main May 7, 2026
7 checks passed
@alexenica alexenica deleted the chore/cli-easy-wins-batch-1-skill-updates branch May 7, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants