Winget manifest uploader #620

Gijsreyn · 2024-12-28T14:01:14Z

PR Summary

This PR adds a function to the build script to upload the assets related to Windows machines to the winget-pkg repository.

PR Context

The function grabs the relevant content types for Windows machines. One switch is introduced to submit the manifest, including a parameter to add the GitHub token.

The only two things remaining is to have it added to the workflow after a release is created and not rebuild the enter project. I was thinking something of this:

name: Winget
on:
  release:
    types: [published]

jobs:
  publish:
    runs-on: <agentName>
    env:
      WINGETCREATE_TOKEN: ${{ secrets.WINGETCREATE_TOKEN }}
    steps:
    - name: Create manifest and submit PR to winget-pkgs
      run: |
        ./build.ps1 -SubmitWinGetManifest -GitToken $env:WINGETCREATE_TOKEN

Note

The OTBS setting formatted some code in the build.ps1 file.

SteveL-MSFT · 2025-03-07T05:14:01Z

@Gijsreyn thanks for this, but I think the team needs to discuss if we want to separately publish to winget given that winget can install from the Store. Just not sure if we want to support this different way of installing.

Gijsreyn · 2025-03-07T13:27:43Z

@SteveL-MSFT Got it Steve. Personally with all the issues related to the store, having the ability to choose the installerType and the source, just throws in a better installation experience. When a user installs it from the winget source, the user in itself can choose for .zip or .msixbundle.

SteveL-MSFT · 2025-06-05T18:56:35Z

@denelon do you think there's value/reason to publish to WinGet repo in addition to the Store?

denelon · 2025-06-05T23:17:21Z

I think there are folks who would prefer WinGet as it can support making earlier versions available as opposed to the store just offering the latest version. If you add the packaged version here in addition to the other methods, users can choose which type they prefer, but WinGet would still default to the MSIX package for a new installation unless the user specifies via arguments or settings.

SteveL-MSFT · 2025-06-06T17:02:34Z

@Gijsreyn can you resolve the merge conflict and I'll review and get this merged. Thanks!

…n/operation-methods into winget-manifest-uploader

…into winget-manifest-uploader

Gijsreyn · 2025-06-06T17:57:42Z

@SteveL-MSFT Merge conflicts resolved. I had to rewrite a little part, because the PR was quite outdated. There's a new switch introduced that switches between Microsoft.DSC or Microsoft.DSC.Preview based on -PreRelease. Do note: the current WinGet repository requires 3 URLs. The .msixbundle is missing from the assets. See earlier talks at #638

denelon · 2025-06-06T18:04:28Z

@Gijsreyn, I'd also suggest taking a look at how PowerToys publishes to WinGet using wingetcreate. @mdanish-kh has done a bunch of these at GitHub.

mdanish-kh · 2025-06-06T18:21:10Z

While this script approach can definitely work, it involves a lot more "plumbing" than what could be simplified into a relatively straightforward post-publish GitHub Action. Examples:

microsoft/terminal <--- Handles both preview and stable releases
microsoft/edit
microsoft/PowerToys

Regardless, if it works it works :)

build.ps1

…n/operation-methods into winget-manifest-uploader

SteveL-MSFT

@Gijsreyn it doesn't seem like all of Muhammad's feedback has been addressed? Also, do we only care about winget for msixbundle or do we expect people to want the zip?

SteveL-MSFT · 2025-07-29T19:54:37Z

build.ps1

+function Submit-DSCWinGetAssets {
+    param(
+        [string]$GitToken,
+        [switch] $IsPreRelease


Suggested change

[switch] $IsPreRelease

[switch]$IsPreRelease

mdanish-kh

I don't think we've addressed the underlying issue for us to be able to automate this properly, which is we don't know what release assets are gonna be available when the release is created / published. Is it gonna be both ZIP & MSIX? Or only ZIP then MSIX is published later? This matters because as I mentioned in #620 (comment), wingetcreate requires the number of URLs passed to update command to match the number of installers in the latest winget-pkgs manifest. That means, if winget-pkgs manifest contains ZIP and MSIX installers, then the update command needs to receive ZIP and MSIX URLs for the new release. If winget-pkgs only contains ZIP, then the update flow expects only a ZIP URL to be provided, otherwise the command will fail. We can debate if this is an area of improvement for wingetcreate (which it may be -> microsoft/winget-create#351 (comment)), but the current flow requires same count of URLs.

Some hacky approaches I can think of:

Retry with multiple commands

Try first with wingetcreate update passing only the ZIP URL -> this will pass if release assets includes ZIP & winget-pkgs manifest for latest DSC version only includes ZIP
If above fails, it probably means the winget-pkgs manifest contains MSIXBundle installer & update command needs the MSIX URL to succeed.
- If the MSIX is available in release asset, pass that to wingetcreate upgrade command along with ZIP URL
- If MSIX is added at a later time to release assets, retry the workflow again when it's added or have the workflow be triggered automatically at a "release edited" event. (this may complicate things if release has to be manually edited for any other reason than adding the MSIX URL, invoking the workflow again for no reason & creating a PR)

on:
  release:
    types: [published, edited]

Only include ZIP for winget-pkgs

This may not be viable since I know some winget-cli workflows depend on the MSIX variant being available from winget-pkgs. However, if we only publish ZIP to winget-pkgs, we can reliably automate the update everytime since we know the ZIP asset is always available on release

mdanish-kh · 2025-07-30T19:52:12Z

.github/workflows/winget.yml

+      - name: Publish Microsoft.DSC ${{ github.event.release.prerelease && 'Preview' || 'Stable' }}
+        run: |
+          $assets = '${{ toJSON(github.event.release.assets) }}' | ConvertFrom-Json
+          $wingetRelevantAsset = $assets | Where-Object { $_.name -like '*.zip' -and $_.name -like '*.msixbundle' } | Select-Object -First 1


This code looks like it's either only gonna get the zip URL OR the MSIX URL, and we don't know which will it be?

SteveL-MSFT · 2025-08-05T17:30:38Z

I don't think we've addressed the underlying issue for us to be able to automate this properly, which is we don't know what release assets are gonna be available when the release is created / published. Is it gonna be both ZIP & MSIX?

Would it make sense to only support MSIX for now? Or do you think users would prefer ZIP since they can just install MSIX via Store (except for Server)?

mdanish-kh · 2025-08-05T19:15:46Z

Would it make sense to only support MSIX for now? Or do you think users would prefer ZIP since they can just install MSIX via Store (except for Server)?

I'm not particularly aware of the user preferences, since I haven't seen an issue at winget-pkgs requesting a particular installer for DSC. Personally I would prefer the packaged MSIX version to be available via WinGet for convenience. Users can install it once & future updates can be handled automatically via the MSFT Store (or manually by WinGet as well). But I don't see why we would want to support "only" MSIX since ZIP is always available in the release assets. No reason to exclude that installation medium when it's always available in the release assets. I feel the question should be should we support MSIX or no, and to that I feel we should. WinGet will always default to MSIX installation if user doesn't specify, but having all installation mediums available gives users more choices.

SteveL-MSFT · 2025-08-05T21:49:16Z

Would it make sense to only support MSIX for now? Or do you think users would prefer ZIP since they can just install MSIX via Store (except for Server)?

I'm not particularly aware of the user preferences, since I haven't seen an issue at winget-pkgs requesting a particular installer for DSC. Personally I would prefer the packaged MSIX version to be available via WinGet for convenience. Users can install it once & future updates can be handled automatically via the MSFT Store (or manually by WinGet as well). But I don't see why we would want to support "only" MSIX since ZIP is always available in the release assets. No reason to exclude that installation medium when it's always available in the release assets. I feel the question should be should we support MSIX or no, and to that I feel we should. WinGet will always default to MSIX installation if user doesn't specify, but having all installation mediums available gives users more choices.

That makes sense. In that case, we should support both MSIX and ZIP

G.Reijn added 2 commits December 28, 2024 14:55

Create function to submit WinGet manifest

2979a2c

Create function to submit WinGet manifest

90a5c5a

Gijsreyn force-pushed the winget-manifest-uploader branch from 2979a2c to 90a5c5a Compare February 27, 2025 10:41

SteveL-MSFT added the Need-Review label Mar 7, 2025

Gijsreyn added 6 commits June 6, 2025 19:38

Merge branch 'winget-manifest-uploader' of https://github.com/Gijsrey…

51ba698

…n/operation-methods into winget-manifest-uploader

Merge branch 'main' of https://github.com/Gijsreyn/operation-methods …

1e51cc0

…into winget-manifest-uploader

Remove unnecessary line

0447293

Resolve merge conflicts

69c7684

Support two versions

1ca6e8d

Merge branch 'main' into winget-manifest-uploader

a9a03ba

mdanish-kh reviewed Jun 6, 2025

View reviewed changes

build.ps1 Outdated Show resolved Hide resolved

mdanish-kh reviewed Jun 6, 2025

View reviewed changes

build.ps1 Outdated Show resolved Hide resolved

mdanish-kh reviewed Jun 6, 2025

View reviewed changes

build.ps1 Outdated Show resolved Hide resolved

Gijsreyn added 4 commits June 7, 2025 03:28

Rebuild with workflow

e5f3d29

Merge branch 'winget-manifest-uploader' of https://github.com/Gijsrey…

2803a35

…n/operation-methods into winget-manifest-uploader

Update workflow file

4b7c7f7

Merge branch 'main' into winget-manifest-uploader

ad3b597

Gijsreyn mentioned this pull request Jun 10, 2025

Search for the latest version of DSC incorrect MicrosoftDocs/PowerShell-Docs-DSC#338

Closed

Gijsreyn added 2 commits July 19, 2025 07:39

Merge branch 'main' into winget-manifest-uploader

2134168

Merge branch 'main' into winget-manifest-uploader

979c718

SteveL-MSFT requested changes Jul 29, 2025

View reviewed changes

Merge branch 'main' into winget-manifest-uploader

41af3bd

Gijsreyn added 3 commits July 30, 2025 01:19

Remove function call

484d6e8

Revert changes in PS script

4490a8d

Revert changes in PS script

68c7061

Gijsreyn requested review from SteveL-MSFT and mdanish-kh July 29, 2025 23:25

mdanish-kh suggested changes Jul 30, 2025

View reviewed changes

Merge branch 'main' into winget-manifest-uploader

f82c7b2

Merge branch 'main' into winget-manifest-uploader

916336f

Winget manifest uploader #620

Are you sure you want to change the base?

Winget manifest uploader #620

Conversation

Gijsreyn commented Dec 28, 2024

PR Summary

PR Context

Uh oh!

SteveL-MSFT commented Mar 7, 2025

Uh oh!

Gijsreyn commented Mar 7, 2025

Uh oh!

SteveL-MSFT commented Jun 5, 2025

Uh oh!

denelon commented Jun 5, 2025

Uh oh!

SteveL-MSFT commented Jun 6, 2025

Uh oh!

Gijsreyn commented Jun 6, 2025

Uh oh!

denelon commented Jun 6, 2025

Uh oh!

mdanish-kh commented Jun 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SteveL-MSFT left a comment

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

mdanish-kh left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Retry with multiple commands

Only include ZIP for winget-pkgs

Uh oh!

mdanish-kh Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT commented Aug 5, 2025

Uh oh!

mdanish-kh commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SteveL-MSFT commented Aug 5, 2025

Uh oh!

Uh oh!

mdanish-kh left a comment •

edited

Loading

mdanish-kh commented Aug 5, 2025 •

edited

Loading