Skip to content

Configuration notes #5357

Open
@mdanish-kh

Description

@mdanish-kh

Description of the new feature / enhancement

Support for a configurationNotes field at the root of the configuration (and possibly at the resource level too, though I can't think of a good use case for it atm). This is to output any string after the configuration has successfully applied the desired state. Possible use cases for project based configurations would be to guide the user for "next steps". For example, the PowerToys configuration has "next steps" written as comments in the file. It would help if one could specify this as a note to be printed at the end of config.

Examples

For VS based projects

~ winget configure .\.config\configuration.winget
DeveloperMode🛡
  Unit successfully applied.
WinGetPackage🛡  [vsPackage]
  Unit successfully applied.
...

Configuration Notes: Now run the solution in Visual Studio and press <kbd>F5</kbd> to compile the project

For JS/TS/Npm based projects

~ winget configure .\.config\configuration.winget
DeveloperMode🛡
  Unit successfully applied.
WinGetPackage🛡  [vsPackage]
  Unit successfully applied.
...

Configuration Notes: Now run 'npm run start' to start the local web server

Proposed technical implementation details

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Issue-FeatureThis is a feature request for the Windows Package Manager client.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions