build: bump docs-extensions-and-macros to ^5.3.1 for doc-tools --plugin - #1867
Closed
micheleRP wants to merge 1 commit into
Closed
build: bump docs-extensions-and-macros to ^5.3.1 for doc-tools --plugin#1867micheleRP wants to merge 1 commit into
micheleRP wants to merge 1 commit into
Conversation
The update-rpk-plugin-docs workflow installs doc-tools with npm ci and calls 'doc-tools generate rpk-docs --plugin <name>', but the lockfile pinned 5.2.5, which predates the --plugin option (added in 5.3.0). Every dispatch fails with "error: unknown option '--plugin'" before reaching PR creation. Refresh the lockfile to 5.3.1 and raise the package.json floor so a future lockfile regeneration can't resolve below it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe package manifest updates Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
Author
|
Closing as duplicate: the update bot's #1864 (now merged) covers the lockfile refresh to 5.3.1, which is all the workflow needs. The extra change here (raising the package.json floor to ^5.3.1) is optional hardening; leaving that call to @JakeSCahill. |
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
1 participant
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.
What
Refresh the lockfile from doc-tools 5.2.5 to 5.3.1 and raise the
package.jsonfloor from^5.1.2to^5.3.1.Why
The
update-rpk-plugin-docsworkflow installs doc-tools withnpm ciand callsdoc-tools generate rpk-docs --plugin <name>, but--pluginonly exists in doc-tools 5.3.0+ (docs-extensions-and-macros#225, released 2026-07-31). With the lockfile at 5.2.5, every dispatch fails at the Refresh plugin docs step witherror: unknown option '--plugin'before reaching PR creation. Verified on run 30682273251 (a manualplugin: aidispatch).Raising the floor to
^5.3.1keeps a future lockfile regeneration from resolving below the version the workflow depends on.Verified locally that 5.3.1's
doc-tools generate rpk-docs --helplists--plugin.@JakeSCahill feel free to close this in favor of a different fix (for example, installing doc-tools explicitly in the workflow) if you'd rather decouple it from the lockfile.
🤖 Generated with Claude Code