microsoft / microsoft/winget-create

wingetcreate submit rewrites manifests

Open
#380 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Bug
Dominant language
C#
Stars
651
Forks
114
Avg merge
7h 52m
Merged PRs (30d)
3

Description

Brief description of your issue

I created a well-formed manifest using YamlCreate but did not want to submit it right away. Later, I used wingetcreate submit <path> to submit the manifest. Upon submission, I found that the comments in the file had been removed and the header was changed to indicate the manifest was created with wingetcreate. This is misleading because the manifest was not created with wingetcreate.

Additionally, any fields that aren't in the current version of the manifest are dropped entirely, meaning that if someone used the field name Documentation instead of Documentations the information would be lost and be unrecoverable without entirely recreating it.

Steps to reproduce

Create a manifest using YamlCreate or Komac, but do not use those tools to submit. Instead, use wingetcreate submit to submit the manifest.

Expected behavior

After the manifest validates successfully, the files should be submitted exactly as they are without modification. There may be important information for reviewers in the comments, optional field names may be misspelled, headers may contain information on the author. This information should be preserved.

Actual behavior

The files are being stripped of comments and the headers are being changed to indicate the manifest was created with wingetcreate, which is not entirely accurate.

It is worth noting that technically the manifest is recreated when using wingetcreate submit and therefore is created using wingetcreate, but that becomes misleading...

Note the difference between the second and third commits in https://github.com/microsoft/winget-pkgs/pull/107999

Environment
PS D:\Git\winget-pkgs> wingetcreate --info
Windows Package Manager Manifest Creator v1.2.6.0

PS D:\Git\winget-pkgs> winget -v
v1.5.1361-preview

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 wingetcreate submit <path> flow and compare the input manifest with the files produced for submission, including the changes shown between the second and third commits in microsoft/winget-pkgs#107999. Done means a successfully validated manifest is submitted without removing comments, changing headers, or dropping fields that are not recognized by the current version.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.