Plugin may set itself as hidden #6605
Merged
+30
−0
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds functionality allowing plugins to mark themselves as hidden, preventing them from appearing in Docker's help output and shell completion.
Key Changes:
- Added a
Hiddenboolean field to the plugin metadata structure - Modified plugin command creation to respect the
Hiddenfield - Updated the management subcommands filter to skip hidden plugins
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| cli-plugins/metadata/metadata.go | Adds Hidden field to plugin metadata |
| cli-plugins/manager/cobra.go | Sets Hidden property when creating plugin command stubs |
| cli/cobra.go | Filters out hidden plugins from management subcommands list |
| cli/cobra_test.go | Adds test coverage for hidden plugin filtering behavior |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Benehiko
force-pushed
the
plugins/hidden
branch
from
e45d313 to
6bb4dce
Compare
Signed-off-by: Alano Terblanche <[email protected]>
Benehiko
force-pushed
the
plugins/hidden
branch
from
6bb4dce to
700875b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 I did
Added a new metadata field so that plugins can mark themselves as hidden. This will hide the plugin from the top-level docker help command as well as shell completion output.
- How I did it
- How to verify it
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)