Repository navigation
SOLR-18515: Preserve hyphenated picocli command names in generated CLI docs - #5068
Merged
Merged
Conversation
Contributor
Author
|
No CL needed for this, can please add no-changelog label for this? |
Contributor
When there is no code changes, only docs / tests, the workflow does not complain about changelog. Something you can try next time: We now have another way of doing it. Simply add a comment |
janhoy
approved these changes
Oct 9, 2026
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.
Description
Preserve hyphenated picocli command names in generated CLI docs
Follow-up of : #5047 via #5047 (comment)
Solution
The CLI docs generator treated every dash in a filename as a command separator, so solr-package-add-key was published as
bin/solr package add key. Copying that invocation fails because the registered name is add-key.cliCommandPath now splits a filename only where the prefix is itself a generated page. Dashes inside the leaf command stay in the name. Page titles, the navigation labels, and the migrated-commands table all use that path.
Regenerated pages for add-key, add-repo, list-available, list-deployed, and list-installed.
bin/solr zk lsandbin/solr snapshot createare unchanged.Used Cursor for code generation. Regenrated CLI docs are vetted.
Tests
Please describe the tests you've developed or run to confirm this patch implements the feature or solves the problem.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.