move cli-plugins metadata types/consts to a separate package#5902
Merged
thaJeztah merged 2 commits intodocker:masterfrom Mar 7, 2025
Merged
move cli-plugins metadata types/consts to a separate package#5902thaJeztah merged 2 commits intodocker:masterfrom
thaJeztah merged 2 commits intodocker:masterfrom
Conversation
This prevents cli-plugins having to import the plugin-manager. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
48b4e5c to
292713c
Compare
Codecov ReportAttention: Patch coverage is
❌ Your patch status has failed because the patch coverage (40.62%) is below the target coverage (50.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## master #5902 +/- ##
==========================================
+ Coverage 59.26% 59.29% +0.02%
==========================================
Files 357 357
Lines 29771 29771
==========================================
+ Hits 17645 17653 +8
+ Misses 11153 11144 -9
- Partials 973 974 +1 🚀 New features to boost your workflow:
|
thaJeztah
commented
Mar 7, 2025
| "os" | ||
|
|
||
| "github.com/docker/cli/cli-plugins/manager" | ||
| "github.com/docker/cli/cli-plugins/metadata" |
Member
Author
There was a problem hiding this comment.
Went a bit back-and-forth what made most sense;
"github.com/docker/cli/cli-plugins/plugin/metadata""github.com/docker/cli/cli-plugins/metadata"
In the end, decided on the last one (for now), because it's shared between both, but let me know what you think!
thaJeztah
commented
Mar 7, 2025
Comment on lines
+3
to
+28
| const ( | ||
| // CommandAnnotationPlugin is added to every stub command added by | ||
| // AddPluginCommandStubs with the value "true" and so can be | ||
| // used to distinguish plugin stubs from regular commands. | ||
| CommandAnnotationPlugin = "com.docker.cli.plugin" | ||
|
|
||
| // CommandAnnotationPluginVendor is added to every stub command | ||
| // added by AddPluginCommandStubs and contains the vendor of | ||
| // that plugin. | ||
| CommandAnnotationPluginVendor = "com.docker.cli.plugin.vendor" | ||
|
|
||
| // CommandAnnotationPluginVersion is added to every stub command | ||
| // added by AddPluginCommandStubs and contains the version of | ||
| // that plugin. | ||
| CommandAnnotationPluginVersion = "com.docker.cli.plugin.version" | ||
|
|
||
| // CommandAnnotationPluginInvalid is added to any stub command | ||
| // added by AddPluginCommandStubs for an invalid command (that | ||
| // is, one which failed it's candidate test) and contains the | ||
| // reason for the failure. | ||
| CommandAnnotationPluginInvalid = "com.docker.cli.plugin-invalid" | ||
|
|
||
| // CommandAnnotationPluginCommandPath is added to overwrite the | ||
| // command path for a plugin invocation. | ||
| CommandAnnotationPluginCommandPath = "com.docker.cli.plugin.command_path" | ||
| ) |
Member
Author
There was a problem hiding this comment.
Didn't mark these as deprecated yet (nor did I remove the GoDoc strings); we could if we wanted to though.
Member
Author
vvoland
reviewed
Mar 7, 2025
Comment on lines
-12
to
-38
| const ( | ||
| // CommandAnnotationPlugin is added to every stub command added by | ||
| // AddPluginCommandStubs with the value "true" and so can be | ||
| // used to distinguish plugin stubs from regular commands. | ||
| CommandAnnotationPlugin = "com.docker.cli.plugin" | ||
|
|
||
| // CommandAnnotationPluginVendor is added to every stub command | ||
| // added by AddPluginCommandStubs and contains the vendor of | ||
| // that plugin. | ||
| CommandAnnotationPluginVendor = "com.docker.cli.plugin.vendor" | ||
|
|
||
| // CommandAnnotationPluginVersion is added to every stub command | ||
| // added by AddPluginCommandStubs and contains the version of | ||
| // that plugin. | ||
| CommandAnnotationPluginVersion = "com.docker.cli.plugin.version" | ||
|
|
||
| // CommandAnnotationPluginInvalid is added to any stub command | ||
| // added by AddPluginCommandStubs for an invalid command (that | ||
| // is, one which failed it's candidate test) and contains the | ||
| // reason for the failure. | ||
| CommandAnnotationPluginInvalid = "com.docker.cli.plugin-invalid" | ||
|
|
||
| // CommandAnnotationPluginCommandPath is added to overwrite the | ||
| // command path for a plugin invocation. | ||
| CommandAnnotationPluginCommandPath = "com.docker.cli.plugin.command_path" | ||
| ) | ||
|
|
Collaborator
There was a problem hiding this comment.
Are these used by other plugins? Should we deprecate and alias before removing?
Member
Author
There was a problem hiding this comment.
Oh! There are aliases, but moved to a separate file; see further up; cli-plugins/manager/annotations.go
I think I had that move in a separate commit originally 🤔 (I can do so separately to make it more clear probably)
Collaborator
There was a problem hiding this comment.
Ahh right, I confused it with the new file 🙈
Member
Author
There was a problem hiding this comment.
😅 I had to double-check myself, but it was there 🤗
vvoland
approved these changes
Mar 7, 2025
This was referenced Aug 18, 2025
This was referenced Sep 1, 2025
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
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.
move cli-plugins metadata types/consts to a separate package
This prevents cli-plugins having to import the plugin-manager.
move cli-plugins annotation consts to a separate package
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)