Skip to content

SOLR-18515: Preserve hyphenated picocli command names in generated CLI docs - #5068

Merged
janhoy merged 8 commits into
apache:mainfrom
jaykay12:SOLR-18515-ref-guide-fix
Oct 15, 2026
Merged

janhoy merged 8 commits into
apache:mainfrom
jaykay12:SOLR-18515-ref-guide-fix

Conversation

@jaykay12

@jaykay12 jaykay12 commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

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 ls and bin/solr snapshot create are 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:

  • I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • I have created a Jira issue and added the issue ID to my pull request title.
  • I have given Solr maintainers access to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
  • I have developed this patch against the main branch.
  • I have run ./gradlew check.
  • I have added tests for my changes.
  • I have added documentation for the Reference Guide
  • I have added a changelog entry for my change

@github-actions github-actions Bot added documentation Improvements or additions to documentation tool:build labels Oct 9, 2026
@jaykay12 jaykay12 changed the title SOLR-18515: Fix for Ref Guide creation for package commands SOLR-18515: Preserve hyphenated picocli command names in generated CLI docs Oct 9, 2026
@jaykay12

jaykay12 commented Oct 9, 2026

Copy link
Copy Markdown
Contributor Author

No CL needed for this, can please add no-changelog label for this?

@jaykay12 jaykay12 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

self-review ✅
@janhoy please help review this.

@janhoy

janhoy commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

No CL needed for this, can please add no-changelog label for this?

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 /no-changelog on the PR, and the label will be set.

@janhoy janhoy added this to the 10.x milestone Oct 15, 2026
@janhoy
janhoy merged commit c9c87d7 into apache:main Oct 15, 2026
3 checks passed
@jaykay12
jaykay12 deleted the SOLR-18515-ref-guide-fix branch October 15, 2026 17:18
dsmiley pushed a commit that referenced this pull request Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tool:build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants