Skip to content

docs: consolidate sort option references#866

Merged
vlad-uipath merged 1 commit into
mainfrom
fix/consolidate-sort-options
May 29, 2026
Merged

docs: consolidate sort option references#866
vlad-uipath merged 1 commit into
mainfrom
fix/consolidate-sort-options

Conversation

@vlad-uipath

Copy link
Copy Markdown
Contributor

Summary

  • Update UiPath skills docs and smoke task to use the consolidated sort options (--sort-by, --sort-order).
  • Adjust stale solution list examples from --take to --limit where they cover the same commands.

Related

Validation

  • git diff --check
  • rg --pcre2 -n -- '--order-by|--order-direction|--sort-dir|--sort(?![-\\w])|order-by|order-direction' skills tests (no matches)
  • bash hooks/validate-skill-descriptions.sh skills/uipath-test/SKILL.md

@github-actions

github-actions Bot commented May 20, 2026

Copy link
Copy Markdown
Contributor

Claude encountered an error after 0s —— View job


I'll analyze this and get back to you.

@github-actions

github-actions Bot commented May 20, 2026

Copy link
Copy Markdown
Contributor

Claude encountered an error after 0s —— View job


I'll analyze this and get back to you.

1 similar comment
@github-actions

github-actions Bot commented May 20, 2026

Copy link
Copy Markdown
Contributor

Claude encountered an error after 0s —— View job


I'll analyze this and get back to you.

@github-actions

github-actions Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Claude finished @vlad-uipath's task in 3m 8s —— View job


PR Review: docs: consolidate sort option references

  • Read review criteria and project conventions
  • Read full diff and PR conversation
  • Review each changed file in context
  • Check for broken links, cross-skill refs, secrets
  • Post review findings

Summary

Straightforward flag rename across 19 files: --order-by--sort-by, --order-direction--sort-order, and --take--limit (only in uipath-solution). All changes are mechanical substitutions aligning docs with CLI PR UiPath/cli#2130. Grep confirms zero remaining references to the retired flags.

Change-by-Change Review

1. skills/uipath-admin/references/identity-commands.md

OK — Clean rename of --order-by--sort-by and --order-direction--sort-order in both the users list and robot-accounts list flag tables. Placeholder style and table structure preserved.

2. skills/uipath-admin/references/user-management.md

OK — Example command updated to match new flags.

3–8. skills/uipath-governance/references/access-policy/*.md and aops-policy/*.md

OK — All six governance reference files correctly updated. The access-policy commands keep the OData combined-expression style (--sort-by "Name asc"), while aops-policy keeps separate --sort-by / --sort-order flags — this correctly reflects different CLI subcommand behaviors.

9–13. skills/uipath-platform/references/**/*.md (5 files)

OKorchestrator.md, setup-environment.md, resources.md, work-with-storage.md, uip-commands.md all updated consistently. The OData-style --sort-by semantics (field + direction in one value) are preserved.

14–15. skills/uipath-rpa/references/tenant-library-search-guide.md and skills/uipath-solution/references/design/tenant-library-search-guide.md

OK — Both copies of the tenant library search guide updated identically (--order-by--sort-by).

16. skills/uipath-solution/references/operate/activate-and-manage.md

Severity: Low — Beyond the flag rename, this file also changes:

  • --take--limit with default bumped from 1050
  • --order-direction "asc"--sort-order "Ascending" (enum value format change)

These are substantive behavioral updates, not just renames. The Ascending/Descending values differ from asc/desc used in other skills (admin, governance) and Asc/Desc used in platform/licensing. This is likely correct per CLI subcommand, but worth confirming the uip solution commands actually accept these exact strings.

17. skills/uipath-solution/references/operate/pack-and-deploy.md

OK — Same changes as #16 applied consistently. The section header deploy list --takedeploy list --limit and surrounding prose updated correctly.

18. skills/uipath-test/SKILL.md

OK — Prose description in the command table updated from order-by to sort-by. This is a description column, not a CLI flag, so it's purely cosmetic and correct.

19. tests/tasks/uipath-governance/access-policy/list_policies_smoke.yaml

OK — Test description, command_pattern regex, and description field all updated from --order-by to --sort-by. The regex --sort-by\s+ is correct for matching the new flag.

What's Missing

  • Nothing identified. The PR scope is well-contained to the flag renames with no new features requiring additional tests or CODEOWNERS changes.

Area Ratings

Area Status Notes
Frontmatter OK No frontmatter changes in this PR
E2E Tests OK Existing smoke task updated to match new flags
Skill Body OK One SKILL.md touched (uipath-test) — prose-only
References & Assets OK All 17 reference files updated consistently
Repo Hygiene OK No secrets, no CODEOWNERS changes needed, scoped cleanly

Issues for Manual Review

  1. --sort-order value format varies across skillsuip admin and uip gov aops-policy use lowercase asc/desc; uip platform groups rules uses Asc/Desc; uip solution uses Ascending/Descending. This appears intentional (each reflects its CLI subcommand's actual API), but worth confirming that uip solution packages list --sort-order "Ascending" and uip solution deploy list --sort-order "Ascending" are the correct accepted values per the CLI PR.

  2. --sort-by combined vs. separate semantics — For uip or and uip gov access-policy, --sort-by takes an OData expression including direction (e.g., "Name asc"). For other commands, direction is a separate --sort-order flag. This is pre-existing and not introduced by this PR, but worth noting as a potential source of agent confusion.

Conclusion

Clean, well-scoped documentation update. All retired flag references have been eliminated (verified by grep). The one substantive change beyond renames — --take--limit with updated defaults in uipath-solution — is correctly applied. No issues blocking merge.

@vlad-uipath vlad-uipath force-pushed the fix/consolidate-sort-options branch from 0f1c765 to e5253f8 Compare May 28, 2026 07:43
@vlad-uipath vlad-uipath requested a review from ganeshborle as a code owner May 28, 2026 07:43
@vlad-uipath vlad-uipath force-pushed the fix/consolidate-sort-options branch from 80825b1 to e9bc2e3 Compare May 28, 2026 11:15
@vlad-uipath vlad-uipath force-pushed the fix/consolidate-sort-options branch from e9bc2e3 to 00a6124 Compare May 29, 2026 06:14

@ganeshborle ganeshborle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vlad-uipath vlad-uipath merged commit adfc49b into main May 29, 2026
20 checks passed
@vlad-uipath vlad-uipath deleted the fix/consolidate-sort-options branch May 29, 2026 08: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.

7 participants