microsoft / microsoft/winget-cli

Configuration notes

Open
#5,357 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Command-Configure Issue-Feature
Dominant language
C++
Stars
26.4k
Forks
1.8k
Avg merge
1d 11h
Merged PRs (30d)
15

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the winget configure command and the configuration.winget examples linked in the issue to understand where configuration output is produced and how root fields are represented. Determine whether notes belong only at the configuration root or also at resource level, then define completion as displaying the configured note after the desired state is successfully applied.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.