Skip to content

docs(uipath-platform): sync with CLI changes — users import, deploy auto-activate, project list, --name filter#499

Merged
alexenica merged 2 commits into
mainfrom
chore/cli-easy-wins-batch-1-skill-updates
May 4, 2026
Merged

docs(uipath-platform): sync with CLI changes — users import, deploy auto-activate, project list, --name filter#499
alexenica merged 2 commits into
mainfrom
chore/cli-easy-wins-batch-1-skill-updates

Conversation

@alexenica
Copy link
Copy Markdown
Contributor

Summary

Sync the uipath-platform skill references with two recent CLI changes:

  • UiPath/cli#1365 — easy-wins batch (timezone IANA, triggers --disabled, queues retention enum, solution project list, solution packages list --name, solution deploy run auto-activate by default + polling fix).
  • UiPath/cli#1423 (OR-92643) — replaces legacy users create/delete with users import (calls AssignDirectoryUser endpoint, references an existing IS principal).

Files changed

File Change
setup-environment.md users createusers import (text, mermaid, complete-example block); add option list with --directory-id / --domain / --type / folder + role flags
pack-and-deploy.md deploy run activates by default; document --skip-activate; drop the stale "polling is unreliable" warning (now fixed via search-API fallback); update flow diagram
activate-and-manage.md Clarify deploy activate is needed only after --skip-activate or to retry a failed auto-activation; add packages list --name <pattern> server-side filter
develop-solution.md New "Step 5: List Projects" section for solution project list; renumber subsequent steps
triggers-and-webhooks.md Document new --disabled flag on triggers create; change example --time-zone from UTC to Europe/Bucharest so IANA expectation is obvious

Notes

  • Queues retention action documentation in process-queues.md was already correct (lists Delete, Archive, None with default) — no change needed.
  • Other resource-tool / agent-tool / solution-design skills had no references to the changed commands.

🤖 Generated with Claude Code

… 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>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

Claude finished @alexenica's task in 2m 1s —— View job


PR Review: docs(uipath-platform) — CLI sync updates

  • Read review criteria and project conventions
  • Get full diff and PR conversation context
  • Read all changed files in full
  • Verify relative links resolve
  • Check for cross-skill references, secrets, and conventions
  • Post review findings

Summary

Syncs five uipath-platform reference docs with two CLI PRs: users createusers import, deploy run auto-activate by default, solution project list, packages list --name, and triggers --disabled + IANA timezone. Changes are well-scoped and factually coherent across files.

Change-by-Change Review

1. skills/uipath-platform/references/orchestrator/setup-environment.md

Severity: OK

Clean replacement of users create with users import across prose, mermaid diagram, option list, and complete-example block. The new option list (--directory-id, --domain, --type, folder+role flags) is well-structured. The note about looking up the Key via users list after import is a helpful adjustment since import no longer returns a Key directly.

2. skills/uipath-platform/references/resources/triggers-and-webhooks.md

Severity: Low

Good additions: --disabled flag documented with use-case context, IANA time-zone expectation made explicit with an Europe/Bucharest example.

Issue: The "Complete Example" block at line 210 still uses --time-zone "UTC" while the Step 2 example (line 62) was changed to "Europe/Bucharest". This is not a bug — the Complete Example uses UTC intentionally for a US-holidays scenario, and the Step 2 example uses Bucharest to demonstrate IANA format. However, the inconsistency could confuse an agent that scans both blocks. Consider adding a brief inline note at line 210 (e.g., # IANA ID — see Step 2 for non-UTC example) or changing it to a non-UTC zone for consistency. Minor point — no action required.

3. skills/uipath-platform/references/solution/activate-and-manage.md

Severity: Medium

The deploy activate scope clarification (lines 34-36) and --name filter example (line 95) are correct and helpful.

Issue — --name missing from options table (line 98-102): The code example shows packages list --name "Invoice" but the options table below it does not include a --name row. An agent reading the table as the authoritative option list will not know the flag exists. Add --name <pattern> to the table.

Fix this →

4. skills/uipath-platform/references/solution/develop-solution.md

Severity: Low

New "Step 5: List Projects" section is well-written — offline-safe note, --solution-folder variant, fallback behavior for Name. Subsequent steps correctly renumbered (6→10).

Minor issue — mermaid flow diagram not updated (lines 20-28): The flow diagram still shows project add / import → resource refresh without a project list node. Since every other project subcommand (add, import, remove) appears in the diagram, project list should too for completeness. Low priority since it's a read-only command and the diagram shows a mutation flow.

5. skills/uipath-platform/references/solution/pack-and-deploy.md

Severity: Low

Auto-activate behavior documented clearly. --skip-activate flag, updated flow diagram with the --skip-activate → deploy activate edge, and the new ActivationStatus response field are all correct.

Observation — searchSearchDeployments22 method name (line 119): The API method name searchSearchDeployments22 has a doubled "search" and a trailing 22 which looks unusual. If this is the actual API method name, fine — but worth a sanity check against the CLI source. If it's a typo for searchDeployments or similar, it would confuse an agent trying to correlate with Swagger docs.

Observation — Stale "Polling false-positives" gotcha (lines 263-265): The PR removed the old polling-unreliable warning from Step 5 and replaced it with the search-API fallback note. However, the "Variations and Gotchas" section at line 263-265 still contains the old warning telling users to always verify with deploy list on polling failure. With the CLI now falling back to the search API, this gotcha may be partially stale — the scenario it describes (polling reports failure but deploy actually succeeded) should now be handled by the CLI itself. Consider softening this to note it as a legacy edge case, or removing it if the fallback is comprehensive.

What's Missing

  • --name not in the packages list options table in activate-and-manage.md (see item 3 above) — Medium.
  • project list missing from mermaid diagram in develop-solution.mdLow.
  • No test task updates: The PR substantially changes documented CLI commands (users import, deploy run auto-activate, project list, --name filter). Existing test tasks in tests/tasks/uipath-platform/ should be checked for coverage of the updated behavior. No new or updated test tasks are included in this PR — Medium per review criteria, though this is common for doc-only PRs in this repo.

Area Ratings

Area Status Notes
Frontmatter OK No frontmatter changes in this PR
E2E Tests ⚠️ Issue No test task updates for changed CLI commands
Skill Body OK SKILL.md not modified
References & Assets ⚠️ Issue --name missing from options table
Repo Hygiene OK CODEOWNERS already covers path; no secrets; no cross-skill refs; all relative links resolve

Issues for Manual Review

  • searchSearchDeployments22 method name (pack-and-deploy.md:119): Verify this is the actual API method name in the CLI source — the doubled "search" and trailing 22 look like they could be a typo or auto-generated versioned name.
  • CLI flag accuracy: The new --disabled, --skip-activate, --directory-id, --domain, and --type flags cannot be verified from documentation alone — confirm they match the CLI --help output from the referenced PRs.
  • "Polling false-positives" gotcha (pack-and-deploy.md:263-265): May be partially stale now that the CLI has a search-API fallback. Verify whether this edge case is still reachable.

Conclusion

Clean, well-scoped documentation sync. One actionable fix: add --name to the packages list options table in activate-and-manage.md. The mermaid diagram gap and stale gotcha are low-priority polish. Recommend approve with the --name table fix.


Follow-up to the previous commit, after a fuller sweep of solution-
related skill files:

* solution.md (overview) — update the lifecycle mermaid to mark deploy
  run as auto-activate, with the activate node now reachable only via
  --skip-activate. Add `project list` to the command tree, and clarify
  in the deploy section that activate is now a follow-up command, not
  a default step.
* pack-and-deploy.md — drop the stale "Polling false-positives on
  deploy run" gotcha; the search-API fallback in the CLI now masks
  the pipeline-record expiry.
* uipath-agents/lowcode/project-lifecycle.md — note that deploy run
  now activates by default and document --skip-activate; add a
  one-liner clarifying when the standalone deploy activate is still
  needed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@alexenica
Copy link
Copy Markdown
Contributor Author

Second pass after a fuller sweep — added 3 more files:

  • `solution.md` (overview) — lifecycle diagram now shows `deploy run` as auto-activate with `--skip-activate` as the route to the standalone `activate` node; added `project list` to the command tree.
  • `pack-and-deploy.md` — dropped the stale "Polling false-positives on deploy run" gotcha (the search-API fallback in UiPath/cli#1365 masks the pipeline-record expiry that triggered it).
  • `uipath-agents/lowcode/project-lifecycle.md` — reframed deploy run as auto-activate with `--skip-activate` opt-out, and added a one-liner clarifying when standalone `deploy activate` is still needed.

Other adjacent skills (uipath-review, uipath-rpa, uipath-rpa-legacy, uipath-test, uipath-coded-apps, uipath-solution-design) reference `uip solution pack` / `uip solution upload` only — none use the changed flags, so no updates needed there.

@alexenica alexenica merged commit e659331 into main May 4, 2026
7 checks passed
@alexenica alexenica deleted the chore/cli-easy-wins-batch-1-skill-updates branch May 4, 2026 12:29
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.

3 participants