PowerShell / PowerShell-RFC

RFC (Request for Comments) documents for community feedback on design changes and improvements to PowerShell ecosystem
MIT License
432 stars 123 forks source link

RFC Get-WhatsNew #317

Closed theJasonHelmick closed 2 years ago

doctordns commented 2 years ago

A great idea. But some details might be useful on the proposed cmdlet. Most importantly - what would be the source for this information. Also, what level of granularity?

theJasonHelmick commented 2 years ago

A great idea. But some details might be useful on the proposed cmdlet. Most importantly - what would be the source for this information. Also, what level of granularity?

@doctordns - This is discussed in the spec in the Data Model section - essentially, we are shipping the same markdown files we use for the web in the module. Is this the detail you are looking for?

Data model

To minimize content maintenance and allow for disconnected scenarios, the data presented by the cmdlet is stored with the module as version specific markdown files.

doctordns commented 2 years ago

I am somewhat unconvinced of the need for this cmdlet. If I want to know what is new, I just use Google/Bing and search. For this to be of much use, the module will need to contain a lot of delta information (what is new between 7.2.1 and 7.2.2). It would need every delta to be separately defined and would almost certainly be the subject of regular updates as well no doubt (to fix typos, etc).

And as for the proposed alias - I would decline this too. I can not see this cmdlet being used all THAT often in an interactive session. Seems to me, if users want to create aliases they can use $Profile.

I suggest that this is added to a PSGallery module to judge the value of adding this as a core PowerShell cmdlet.

theJasonHelmick commented 2 years ago

I suggest that this is added to a PSGallery module to judge the value of adding this as a core PowerShell cmdlet.

@doctordns - Yup, I think we are on the same page - here's what I put int he spec. https://github.com/PowerShell/PowerShell-RFC/pull/317/files#:~:text=%23%23%20Solution,Windows%20PowerShell%205.1

Solution

Ship a Microsoft.PowerShell.WhatsNew module on the PowerShell Gallery that contains the cmdlet and would:

doctordns commented 2 years ago

There might be some merit in a Power Toys type module. It could contain this cmdlet, as well as a command to update-PowereShell and maybe even a cmdlet to download help information for modules not on a given host. And other useful things around managing PowerShell?

dcaro commented 2 years ago

Couple of comments:

theJasonHelmick commented 2 years ago

@dcaro - comments inline:

Couple of comments:

  • Could we consider exposing what's new not just for PowerShell but also for other modules installed.

Yes, it would be possible to change the data source to a service that provides this information. Based on community feedback, this is something we could look toward in a. future release.

  • The amount of information returned can be large. It may worth considering displaying only header and offering the possibility to obtain details intool or online.

This has been discussed such as a -online switch and clickable hypertext. Open to discussing output formatting options for a future version.

theJasonHelmick commented 2 years ago

Closing this PR.

The specification for Get-WhatsNew is not intended to be included with PowerShell. This will be published as a separate module on the Gallery supporting PowerShell 7 and down-level to Windows PowerShell 5.1.