docs(coded-apps): correct deploy, publish, auth & asset guidance in coded apps skill [APPS-35786] - #2537
docs(coded-apps): correct deploy, publish, auth & asset guidance in coded apps skill [APPS-35786]#2537ninja-shreyash wants to merge 2 commits into
Conversation
Verified against the live env (codedapp-tool 1.197) and CLI source; each change is either a reproduced behavior or a source-confirmed correction. - publish `-v`: was documented as defaulting to "Latest" — corrected to the real behavior (first unsorted `readdir` match; always pass `-v` when multiple versions of the same name exist), per `publish.ts` findPackageByName. - deploy `--path-name`: document routing-name rules on upgrade — omit to keep the URL; a new slug rewrites it; a taken/previously-used slug fails with `routing name must be unique`. Fresh-vs-upgrade is decided by whether the app is already deployed, not by version. - deploy: add indexing-lag troubleshooting row — `has not been published yet` right after publish is catalog lag, not a missing package (CLI retries ~15s). - auth: standardize on the `uip login` session model — org/tenant/base/token resolve from the session (any login type), not a project `.env`; flags are override-only. Kept the client-credential `Apps.Read Apps.Write` scope gotcha. - folder key: resolve via server-side `uip or folders list --all --name` with exact-Name match (list is paginated 50/page; `--name` is a contains match). - pack/publish: `pack` copies `uipath.json` verbatim (does not mint/modify the clientId); removed the dead `--reuse-client` flag. - publish troubleshooting: correct the `already exists` message + cause. - assets (Rule 9): import static assets through the bundler; do not use `public/` or hardcoded `/`-rooted paths (they 404 under the non-root mount). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Claude finished @ninja-shreyash's task in 4m 24s —— View job PR Review: fix(coded-apps): close deploy/publish/auth doc gaps from APPS-35786
SummaryCorrects several documentation inaccuracies in the coded-apps skill around auth session model ( Change-by-Change Review1.
|
| Area | Status | Notes |
|---|---|---|
| Frontmatter | OK | No frontmatter changes |
| E2E Tests | OK | Documentation-only PR; existing tests in tests/tasks/uipath-coded-apps/ cover the workflows |
| Skill Body | OK | Rule 9 and Rule 11 updates are accurate and well-scoped |
| References & Assets | Issue | Agent flow example contradicts corrected folder guidance; one troubleshooting row still references .env |
| Repo Hygiene | OK | Changes scoped to one skill; CODEOWNERS present; no secrets or personal paths |
Issues for Manual Review
- Publish
-vreaddirorder claim (commands-reference.md:170, pack-publish-deploy.md:114): The PR states-vselects the "first matching.nupkgin unsortedreaddirorder — NOT the highest version." This is cited as verified againstpublish.ts'sfindPackageByName. Since this is a behavioral claim about internal CLI code, it cannot be verified from the docs alone — the PR author should confirm this still holds in the latest CLI release. - Personal workspace in
--all --type personal(pack-publish-deploy.md:260): The text says personal workspace is "not in--all" but then offersuip or folders list --all --type personalas an alternative. If personal workspaces aren't in--all, the--all --type personalalternative wouldn't return them either. Worth verifying which is correct.
Conclusion
Solid, well-researched PR that fixes real documentation inaccuracies verified against CLI source. The corrections are consistent and well-scoped. Two items need attention before merge: (1) the "Agent flow" example at pack-publish-deploy.md:344 still uses the old folder-list pattern, directly contradicting the new guidance 100 lines above — this is the kind of inconsistency that causes an agent to use the wrong approach; (2) one troubleshooting row still references .env counter to the PR's session-model corrections. Both are straightforward fixes. Recommend addressing those two items, then this is good to merge.
…ientId row The removed-flag warning already lives in the clientId-section blockquote and the dedicated `unknown option '--reuse-client'` troubleshooting row. The "wrong clientId" row is about a stale uipath.json — a different problem — so it no longer repeats the flag aside. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Summary
Closes the APPS-35786 runbook. Each of the 10 gotchas was verified against the live env (
codedapp-tool1.197) or CLI source before deciding if the skill needed a change. Docs-only — no CLI change required.Points
version already exists--reuse-clientremoved;clientIdfromuipath.jsonpackcopiesuipath.jsonverbatim; dropped dead flag--folder-key--all--all --name+ exact-Name match--path-nameon upgraderouting name must be unique; new slug rewrites URL-v;has not been published yetindex.htmlisno-cache; assets content-hashed — normal reload worksuip login, not.env); keptApps.Read Apps.Writegotchauipathreserved,microsoftnot (ticket stale); CLI error is self-explanatory + list is volatilepublic//hardcodedPlus two bonus doc-bug fixes found while testing: publish
-vwas wrongly documented as "Latest" (it's the first unsortedreaddirmatch), and.envwas wrongly listed as the auth source (it's theuip loginsession).Verification
Live (popoc/adetenant, alpha): full pack→publish→deploy upgrade cycles;
--path-namematrix (same/new/reserved slug × fresh/upgrade) mapping the success ↔routing name must be uniqueboundary (5, 9);curl -Icache headers on the deployed URL (7); reserved-word probes (9); all commands ran flagless off the login session (8).CLI source (
codedapp-tool, read-only):deploy.ts(fresh-vs-upgrade branch, uniqueness check, retry[1,2,4,8]s),publish.ts(findPackageByNamefirst-match),resolve-credentials.ts/env-config.ts(flag→session→alt precedence).🤖 Generated with Claude Code