feat: add api to register cli updater (#4690) #5064
Conversation
Signed-off-by: lstocchi <lstocchi@redhat.com>
lstocchi
requested review from
dgolovin,
cdrage and
jeffmaury
and removed request for
a team
| @@ -2506,6 +2522,12 @@ declare module '@podman-desktop/api' { | |||
| id: string; | |||
| label: string; | |||
| }; | |||
|
|
|||
| updateVersion(version: CliToolUpdateOptions): void; | |||
There was a problem hiding this comment.
hello, I'm wondering why we need to pass so many things in the update function like displayName, images, path, etc ?
There was a problem hiding this comment.
for me a new version could have a different description, display name, icon.
There was a problem hiding this comment.
maybe in a new version there is something super which is supported or not supported anymore and you want to mention it in the description, or mark it in the name, or the icon has different color. Idk
There was a problem hiding this comment.
in that case, maybe the extension unregister the current CliTool and register a new one ?
for the images, I would say that as they come with the extension, probably if CLI has a new icon we will update the new icon in a newest extension but it won't be different in all the calls (like between register and update)
I'll wait other reviews, but it looks a little bit over-engineering to me.
| displayName?: string; | ||
| markdownDescription?: string; | ||
| images?: ProviderImages; | ||
| path?: string; |
There was a problem hiding this comment.
Should we also include the asset name, as when retrieving the / installing the new update, you'll have to pass in the asset name determined by the extension (example, hey, install arm64 darwin).
Or should we just do quickpick / prompt for now?
There was a problem hiding this comment.
it's the extension that is doing the update so extension is aware on asset name to pick-up
There was a problem hiding this comment.
the extension has already a reference of the cli that it wants to update as it registered it during the activation. So you're going to do cli.update(new data) from the extension when the user asks for it. There is no need for the asset name.
I didn't make it updatable as I see it like an id. You can change the display name, description, version but the asset name should be the same, otherwise you're most probably registering a new cli tool.
What does this PR do?
It adds the logic to register an cli updater which will be called on request to update a cli.
Screenshot/screencast of this PR
For gif to see how it will be used/work check #5054
What issues does this PR fix or reference?
this is a part of #4690.
How to test this PR?