Vscode: Offer to open changelog when an extension is updated

Created on 1 Mar 2017  路  16Comments  路  Source: microsoft/vscode

With every update to VS Code, users now get a prompt to read the release notes.
It would be nice to have the same feature for extensions. Prompt to read the Changelog (if exists) on every update to the extension

Edit:
Prompt might be a bit much, too many notifications. Instead a "What's new" button or a similar option when clicking on the gear icon would be better

extensions feature-request

Most helpful comment

-1, I have set my extensions to auto update and I would never want to see any release editor opening. I am quite happy with this kind of silent updates.

All 16 comments

Slack has this "gift" icon. On hover it says "What's new". Clicking opens a side pane with the new features.

In the extensions pane, we now have the "Update to .." button when there is an update available.
We can use the same space for a "What's new" button when there is no update and changelog exists for the extension. Clicking on which should open the Changelog tab.

@stevencl Thoughts?
cc @Microsoft/vscode

I like the idea of increasing the visibility of extensions' progress. One issue might be that all extensions end up having that changelog button because (almost) all have a prior version. That would decrease its value as a 'highlight'.

-1, I have set my extensions to auto update and I would never want to see any release editor opening. I am quite happy with this kind of silent updates.

As long as it doesn't come as notification, I'm fine with that... The more I call showInformationMessage, the less chances I have to get into Heaven.

A 'What's new' button after the user has updated an extension would be a decent solution. I definitely don't think we should be notifying the user.

Once the user closes VS Code and restarts, we would remove the What's New button. We could consider then exposing a 'View changelog' action in the gear/settings menu to provide access to the changelog if it exists. That way we could avoid the problem that @chrmarti points out.

Agreed on the "no more notifications please" thought.
Updated the issue description accordingly.

I would LOVE to see a feature like this. I've posted some of my comments here: https://github.com/eamodio/vscode-gitlens/issues/222#issuecomment-354311075

Personally I think it is important for an extension to be able to provide details around an update (changelog, release notes, etc). But the current notification mechanism is far from ideal. IMO, it should be something discoverable but passive.

I kind of like the idea of a badge on the extensions button (which would go away if you open the extension pane) if there have been any updates. And then individual badge each extension that has been updated -- that would bring you to a changelog or something like that. Although the downside, is lots of badges that might not get looked at and therefore not cleared, which would just become visual noise.

Another option, would still have the same badge on the extensions button, but the extensions pane would also have that badge as a button somewhere, and clicking that would open up a single screen, with a list of any updates. This could either be automatic (i.e. vscode will track the updates), manual (a new api for an extension to add an entry), or a combination of both. I think a combination would be ideal. Where vscode would track the simple, Extension Foo was upgraded from 1.0 -> 2.0 (maybe with a changelog link if there is one), and an extension could add additional details (bounded) through a new api -- maybe something like showInformationMessage (addUpdateMessage)?

Thoughts?

@bpasero This is something we should include in the notification improvement story #22388?

@ramya-rao-a yeah we briefly touched on this. what if the update notification for an extension would show within the extensions viewlet instead of the global notification area?

That would work, are we planning to cover that as part of #22388?

@ramya-rao-a no, we would probably need a new story for that one. What we have planned is to show the source of a notification more prominently so distinguish core notifications from extension notifications.

+1 on VS Code's adding the ability for an extension to display release notes in a centralized, not-in-your-face way that users could enable or disable. I've seen several extensions open up release notes automatically after they're updated (e.g. C/C++ extensionm, see below). We'd also like the ability to let users know when new features are available, but if we do it ourselves it will add more noise.

@chrisdias and @fiveisprime did a survey to see whether customers would like this feature - 90% of users indicated they liked the feature, but half felt it was annoying as currently implemented:

image

Further from Chris

I think we want to do something in the core product to make this experience better, so I wouldn鈥檛 put this into the extension(s) yet. I can imagine a new type of notification (hidden by default maybe?), a better badge system, a way to go to the extension changelog.md, etc. Then, the azure extensions can plug into that model.

FYI, here' an example of a current extension full-screen notification (not us :-):
image

(Not sure how this issue relates to https://github.com/Microsoft/vscode/issues/44020.)

Is this implemented yet? Because I think I saw a notification in vscode about an extension been updated and button which opens the extension's changelog

Not yet, but I will be starting to explore based on the feedback that is provided here. So ideas are very much welcome.

There's discussion happening here - https://github.com/microsoft/vscode/issues/102139

Was this page helpful?
0 / 5 - 0 ratings