Improve YAML Parsing

[Trenly]

Summary

This PR updates the YamlCreate.ps1 script to be more fully-featured and uses powershell-yaml (See it on GitHub) to handle the parsing of keys and values

Major Updates

• Script documentation added under /doc/tools/YamlCreate.md
• PackageId, PackageVersion, Mode, and Settings parameters added as optional
• Validation of inputs against the manifest schema
• Ability to fill in PR parameters when submitting PR's automatically
  • Ability to link issues when submitting a PR
• Quick update mode added for when only InstallerURL's change
• Allows for locales other than en-US as the defaultLocale
• User can customize their settings for the script
• Checks for PR's that may be for the same change

Minor Updates

• Bumped script version and updated header
• Installer keys are sorted based on the order in the schema
• Automatic detection of architecture and installer type where possible
• Automatic detection of package family name, where possible
• Changed the termination types to be exit when a user choice exits the script and throw when the script terminates unexpectedly
• Throws descriptive exceptions with inner exceptions for debugging
• Delete mode for removing package versions, with reason
• Handles file names in a safer manner
• Handles branch names in a safer manner
• Uses quasi-unique branch names
• Suppresses much of the git output which is not necessary to show

---

• Have you signed the Contributor License Agreement?
• Have you checked that there aren't other open pull requests for the same manifest update/change?

---

Resolves #21940
Resolves #21219

Microsoft Reviewers: Open in CodeFlow

[ghost]

Hello @Trenly,
The package manager bot determined there was an issue with the pull request. Make sure the manifest files are under the manifests\partition\publisher\appname\version directory. The partition of the path must be the first letter of the publisher in lower-case.

Example:
Path: manifests / m / Microsoft / WindowsTerminal / 1.6.10571.0 / WindowsTerminal.yaml

For details on the error, see the details link below in the build pipeline.

You may also try the Windows Package Manager Manifest Creator

[Trenly]

Something weird happened with the commit history when I tried to rebase on master. I revered back to before the rebase. I'll rebase to resolve the merge conflicts before going too much further

[ghost]

Hello @Trenly,
The PR could not be validated because there is a merge conflict which adds bad characters to the manifest. Please address the merge conflict and resubmit.

[Trenly]

@OfficialEsco I believe this is all I have left -

<#
TO-DO:
    - Handle writing null parameters as comments
    - Ensure licensing for powershell-yaml is met
#>

I'm not sure how to write comments with powershell-yaml, so that may be difficult. As far as I can tell, there aren't any licensing requirement for powershell-yaml since we aren't using the source code in any way, but I would like someone else to verify that.

Other than those two things, I believe this is ready for testing

[denelon]

@Trenly is it this one?

[Trenly]

@Trenly is it this one?

Yes, It is that one

[OfficialEsco]

Issue 1:

[Optional] Enter any Protocols the application provides a handler for. For example: http, https (Max 16)
Protocols:

[Optional] Enter any Commands or aliases to run the application. For example: msedge (Max 16)
Commands:

[Optional] List of additional non-zero installer success exit codes other than known default values by winget (Max 16)
Commands:

Feature Request:
Keep Metadata outside of hardcoded metadata (do we have to hardcode all the different metadata fields?)

Untested:
Does it work as expected with additional locales? (Copying them to the new version)

I'll keep testing it if i can find any non submitted versions which have gotten harder 😠

Edit: On last issue revealed itself at the end

Submit PR?
Do you want to submit your PR now?
[Y] Yes  [N] No (default is 'Y'): yUpdate
PS C:\Users\Esco\Github\winget-pkgs>

[Trenly]

@jedieaston @vedantmgoyal2009 I believe these are the only issues remaining:

RuleName                            Severity     ScriptName Line  Message                                                     
--------                            --------     ---------- ----  -------                                                     
PSReviewUnusedParameter             Warning      YamlCreate 886   The parameter 'InputObject' has been declared but not used. 
                                                 .ps1                                                                         
PSReviewUnusedParameter             Warning      YamlCreate 889   The parameter 'NoComments' has been declared but not used.  
                                                 .ps1                                                                         

I looked and I see these parameters being used, so I think they are false positives

[Trenly]

@denelon I've left the commit history mostly in-tact up until this point; Would you have any objection if I rewrite the history of this branch to reduce the amount of clutter?

[jedieaston]

If you rebase we might lose some of the commit data for the PRs in your fork (I think). If this will be squashed on merge anyway, do you need to clear it now?

[Trenly]

If you rebase we might lose some of the commit data for the PRs in your fork (I think). If this will be squashed on merge anyway, do you need to clear it now?

It depends on how the rebase is performed; I just don’t know if it will be squash merged here or just merged

[denelon]

We squash merge.

[Trenly]

@denelon I know it's a big ask, but how long do you think review will take?

[denelon]

I'll see if I can get someone to look at this today or tomorrow. We have a lot in flight right now. Sorry this is taking so long.

[Trenly]

I'll see if I can get someone to look at this today or tomorrow. We have a lot in flight right now. Sorry this is taking so long.

No worries. I completely understand having a lot in flight. There is no rush on this, I understand it's a community submission and that you guys have a lot of other things to be working on. I appreciate all your help in getting this reviewed though, it truly means a lot

[Trenly]

@jedieaston @OfficialEsco Would you mind reviewing this PR for @denelon ?

[jedieaston]

I ran through it one more time, there doesn't seem to be any outstanding uh-ohs that we haven't noted.

[Trenly]

There doesn't seem to be any outstanding uh-ohs that we haven't noted.

Found one from the latest fixes to the CLI; Patched it