Conversation
…nit tests for version helpers
…ctionable hints in error messages
…s definition key, and improve job state filtering in tests
There was a problem hiding this comment.
Pull request overview
This PR bundles several CLI usability and reliability improvements across profiles/help UX, search determinism, and plugin management, plus accompanying documentation and test updates.
Changes:
- Added dedicated
helpoutput forprofilesandplugin(s), and expanded shell completion coverage accordingly. - Fixed Modeler Cloud connection mapping so OAuth
audienceremains optional unless explicitly provided. - Improved search determinism (process definition sorting) and case-insensitive variable search pagination; stabilized related integration tests.
- Enhanced plugin listing with version visibility and implemented source-aware upgrade/downgrade behavior, including new unit/integration coverage and docs.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/unit/plugins-version.test.ts | Adds unit coverage for plugin version helper functions. |
| tests/unit/help.test.ts | Extends help tests to cover profiles and plugin(s) detailed help. |
| tests/unit/config.test.ts | Adds regression tests for Cloud connection audience handling. |
| tests/integration/search.test.ts | Stabilizes search integration tests using instance-based key extraction and job filtering. |
| tests/integration/plugin-lifecycle.test.ts | Adds version visibility assertion and upgrade/downgrade behavior tests for file-sourced plugins. |
| src/config.ts | Updates Cloud Modeler connection mapping to keep audience optional and allow custom OAuth URL. |
| src/commands/search.ts | Adds deterministic sorting for process definitions and paginates case-insensitive variable searches. |
| src/commands/plugins.ts | Adds version helpers, shows versions in list plugins, and makes upgrade/downgrade source-aware. |
| src/commands/help.ts | Adds help profiles and help plugin(s) detailed help output and wiring. |
| src/commands/completion.ts | Expands completion suggestions to include profiles/profile/plugin/plugins help topics. |
| README.md | Documents new help entrypoints and plugin version/source-aware upgrade/downgrade behavior. |
| PLUGIN-HELP.md | Documents source-aware upgrade/downgrade semantics by source type. |
| EXAMPLES.md | Adds examples for profile help and source-aware plugin upgrade/downgrade; updates plugin list example with Version column. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
This has been released in 2.1.0-alpha.4. |
|
This has been released in 2.1.0. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(ping to https://github.com/camunda/product-hub/issues/2638 for tracability)
Summary
This PR bundles several low-hanging but high-impact CLI improvements across profiles, search, and plugins.
It improves discoverability (
help+ completion + docs), fixes a profile auth edge case for imported Modeler connections, adds source-aware plugin upgrade/downgrade behavior, and hardens flaky integration paths in search/plugin lifecycle tests.What changed
Profiles and help UX
c8 help profilesoutput (includingprofilealias handling) insrc/commands/help.ts.src/commands/completion.ts.README.mdandEXAMPLES.md.tests/unit/help.test.ts.Profile/auth fix
audiencestays optional unless explicitly configured (instead of being forced) insrc/config.ts.tests/unit/config.test.ts.Search behavior and test stability
src/commands/search.ts.tests/integration/search.test.tsto avoid eventual-consistency flakiness.Plugin management improvements
src/commands/plugins.ts.tests/integration/plugin-lifecycle.test.tstests/unit/plugins-version.test.tsPLUGIN-HELP.md.Why
Diff