microsoft / winget-create

The Windows Package Manager Manifest Creator command-line tool (aka wingetcreate)
MIT License
489 stars 84 forks source link

wingetcreate submit rewrites manifests #380

Open Trenly opened 1 year ago

Trenly commented 1 year ago

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