Merge branch 'main' into copilot/add-custom-location-winapp

JesseCol · web-flow · commit 49091ee95600 · 2025-11-21T12:59:06.000-08:00
diff --git a/.pipelines/release.yml b/.pipelines/release.yml
@@ -13,6 +13,7 @@ resources:
 
 parameters:
   - name: DoEsrp
+    displayName: Sign the binaries and package (DoEsrp)
     type: boolean
     default: true
   - name: signingIdentity
@@ -25,6 +26,10 @@ parameters:
       authCertName: $(SigningAuthCertName)
       signCertName: $(SigningSignCertName)
       signTTSCertName: $(SigningSignTTSCertName)
+  - name: GitHubReleaseAlreadyExists
+    displayName: GitHub Release already exists, skip uploading GitHub release (GitHubReleaseAlreadyExists)
+    type: boolean
+    default: false
 
 extends:
   template: v1/1ES.Official.PipelineTemplate.yml@1esPipelines
@@ -128,91 +133,97 @@ extends:
               includeRootFolder: false
               archiveFile: $(Pipeline.Workspace)/winappcli-$(version)-arm64.zip
 
-          - task: GitHubRelease@1
-            displayName: "Create GitHub Release"
-            inputs:
-              gitHubConnection: 'github-service-connection'
-              repositoryName: 'microsoft/winappcli'
-              action: 'create'
-              target: '$(Build.SourceVersion)'
-              tagSource: 'userSpecifiedTag'
-              tag: 'v$(version)'
-              title: 'Release v$(version)'
-              isPreRelease: true
-              assets: |
-                $(Pipeline.Workspace)/winappcli-*.zip
-                $(Pipeline.Workspace)/msix-packages/*.msix
-                $(Pipeline.Workspace)/npm-package/*.tgz
-              assetUploadMode: 'delete'
-              addChangeLog: false
-              releaseNotesSource: 'inline'
-              releaseNotesInline: |
-                🚀 **Automated Release Build**
+          - ${{ if ne(parameters.GitHubReleaseAlreadyExists, 'true') }}:
+            - task: GitHubRelease@1
+              displayName: "Create GitHub Release"
+              inputs:
+                gitHubConnection: 'github-service-connection'
+                repositoryName: 'microsoft/winappcli'
+                action: 'create'
+                target: '$(Build.SourceVersion)'
+                tagSource: 'userSpecifiedTag'
+                tag: 'v$(version)'
+                title: 'Release v$(version)'
+                isPreRelease: true
+                assets: |
+                  $(Pipeline.Workspace)/winappcli-*.zip
+                  $(Pipeline.Workspace)/msix-packages/*.msix
+                  $(Pipeline.Workspace)/npm-package/*.tgz
+                assetUploadMode: 'delete'
+                addChangeLog: false
+                releaseNotesSource: 'inline'
+                releaseNotesInline: |
+                  🚀 **Automated Release Build**
 
-                Version: `$(version)`
-                Commit: `$(Build.SourceVersion)`
+                  Version: `$(version)`
+                  Commit: `$(Build.SourceVersion)`
 
-                ## Installation Options
+                  ## Installation Options
 
-                ### 📦 MSIX Installer (Recommended)
-                1. Download `winappcli_$(version).0_x64.msix` for x64 or `winappcli_$(version).0_arm64.msix` for ARM64
-                2. Double-click to install
-                3. Automatically added to PATH
+                  ### 📦 MSIX Installer (Recommended)
+                  1. Download `winappcli_$(version).0_x64.msix` for x64 or `winappcli_$(version).0_arm64.msix` for ARM64
+                  2. Double-click to install
+                  3. Automatically added to PATH
 
-                ### 📦 Standalone CLI Binaries
-                1. Download `winappcli-$(version)-x64.zip` for x64 or `winappcli-$(version)-arm64.zip` for ARM64
-                2. Extract to your desired location
-                3. Add to PATH or run directly: `winapp.exe`
+                  ### 📦 Standalone CLI Binaries
+                  1. Download `winappcli-$(version)-x64.zip` for x64 or `winappcli-$(version)-arm64.zip` for ARM64
+                  2. Extract to your desired location
+                  3. Add to PATH or run directly: `winapp.exe`
 
-                ### 📚 NPM Package (for Electron or NodeJS)
-                ```bash
-                npm install microsoft-winappcli-$(version).tgz
-                ```
+                  ### 📚 NPM Package (for Electron or NodeJS)
+                  ```bash
+                  npm install microsoft-winappcli-$(version).tgz
+                  ```
 
-                ## What's Included
-                - ✅ MSIX installer packages (x64 and ARM64)
-                - ✅ Standalone CLI binaries (x64 and ARM64)
-                - ✅ NPM package for NodeJS/Electron integration
+                  ## What's Included
+                  - ✅ MSIX installer packages (x64 and ARM64)
+                  - ✅ Standalone CLI binaries (x64 and ARM64)
+                  - ✅ NPM package for NodeJS/Electron integration
 
-    # Commented out ESRP release to npm for now
-    # - ${{ if eq(parameters.DoEsrp, 'true') }}:
-    #   - stage: Release_Npm
-    #     displayName: Create Npm Release
-    #     dependsOn: Release_GitHub
-    #     jobs:
-    #     - job: create_npm_release
-    #       pool:
-    #         name: Azure-Pipelines-1ESPT-ExDShared
-    #         image: windows-latest
-    #         os: windows
-    #         hostArchitecture: amd64
-    #       displayName: NPM Release
-    #       templateContext:
-    #         type: releaseJob
-    #         isProduction: true
-    #         inputs:
-    #         - input: pipelineArtifact
-    #           artifactName: npm-package
-    #           targetPath: $(Pipeline.Workspace)/npm-package
-    #       steps:
-    #         - task: EsrpRelease@10
-    #           condition: always()
-    #           inputs:
-    #             ConnectedServiceName: ${{ parameters.signingIdentity.serviceName }}
-    #             usemanagedidentity: true
-    #             keyvaultname: ${{ parameters.signingIdentity.akvName }}
-    #             signcertname: ${{ parameters.signingIdentity.signTTSCertName }}
-    #             clientid: ${{ parameters.signingIdentity.appId }}
-    #             intent: 'PackageDistribution'
-    #             contenttype: 'npm'
-    #             contentsource: 'Folder'
-    #             folderlocation: $(Pipeline.Workspace)/npm-package/
-    #             waitforreleasecompletion: true
-    #             owners: '$(EsrpOwnersEmail)'
-    #             approvers: '$(EsrpApproversEmail)'
-    #             serviceendpointurl: 'https://api.esrp.microsoft.com'
-    #             mainpublisher: 'winappcli'
-    #             domaintenantid: ${{ parameters.signingIdentity.tenantId }}
+    - ${{ if eq(parameters.DoEsrp, 'true') }}:
+      - stage: Release_Npm
+        displayName: Create Npm Release
+        dependsOn: Release_GitHub
+        jobs:
+        - job: create_npm_release
+          pool:
+            name: Azure-Pipelines-1ESPT-ExDShared
+            image: windows-latest
+            os: windows
+            hostArchitecture: amd64
+          displayName: NPM Release
+          templateContext:
+            type: releaseJob
+            isProduction: true
+            inputs:
+            - input: pipelineArtifact
+              artifactName: npm-package
+              targetPath: $(Pipeline.Workspace)/npm-package
+          steps:
+            - task: PowerShell@2
+              displayName: "Echo debug info"
+              inputs:
+                targetType: 'inline'
+                script: |
+                  Write-Host "SigningServiceName: ${{ parameters.signingIdentity.serviceName }}"
+            - task: EsrpRelease@10
+              condition: always()
+              inputs:
+                ConnectedServiceName: ${{ parameters.signingIdentity.serviceName }}
+                usemanagedidentity: true
+                keyvaultname: ${{ parameters.signingIdentity.akvName }}
+                signcertname: ${{ parameters.signingIdentity.signTTSCertName }}
+                clientid: ${{ parameters.signingIdentity.appId }}
+                intent: 'PackageDistribution'
+                contenttype: 'npm'
+                contentsource: 'Folder'
+                folderlocation: $(Pipeline.Workspace)/npm-package/
+                waitforreleasecompletion: true
+                owners: '$(EsrpOwnersEmail)'
+                approvers: '$(EsrpApproversEmail)'
+                serviceendpointurl: 'https://api.esrp.microsoft.com'
+                mainpublisher: 'ESRPRELPACMAN'
+                domaintenantid: ${{ parameters.signingIdentity.tenantId }}
 
     - stage: Release_WinGet
       displayName: Create WinGet Release
@@ -235,21 +246,43 @@ extends:
             displayName: "Publish to WinGet"
             env:
               # PAT lasts 90 days, regenerate as needed and re-run if it failes due to authentication
-              WINGET_CREATE_GITHUB_TOKEN: $(GITHUB_TOKEN)
+              WINGET_CREATE_GITHUB_TOKEN: $(GITHUB_TOKEN_2)
+              GH_TOKEN: $(GITHUB_TOKEN_2)
             inputs:
               targetType: 'inline'
+              errorActionPreference: 'stop'
               script: |
                 # Download and install C++ Runtime framework package
                 Write-Host "Installing VCLibs dependency..."
                 $vcLibsFile = "Microsoft.VCLibs.x64.14.00.Desktop.appx"
                 Invoke-WebRequest https://aka.ms/Microsoft.VCLibs.x64.14.00.Desktop.appx -OutFile $vcLibsFile
                 Add-AppxPackage $vcLibsFile
                 
+                # Install gh
+                # TODO: Change this to get the latest version of gh
+                Write-Host "Installing gh..."
+                $tempDir = "$(Agent.TempDirectory)"
+                Write-Host "TempDir: $tempDir"
+                Invoke-WebRequest -Uri "https://github.com/cli/cli/releases/download/v2.83.1/gh_2.83.1_windows_amd64.zip" -OutFile "$tempdir\gh.zip"
+                Expand-Archive "$tempdir\gh.zip" -DestinationPath "$tempDir\gh"
+
                 # Download and install wingetcreate
                 Write-Host "Installing wingetcreate..."
                 $wingetCreateBundle = "wingetcreate.msixbundle"
                 Invoke-WebRequest https://aka.ms/wingetcreate/latest/msixbundle -OutFile $wingetCreateBundle
                 Add-AppxPackage $wingetCreateBundle
+
+                # WinGetCreate uses an existing fork of the microsoft/winget-pkgs repo to create the PR
+                # that updates the main repo.  This fork will be under the account attached to the token.
+                # We need to keep this fork up-to-date, otherwise the wingetcreate command will fail.
+                # See: https://github.com/microsoft/winget-create/issues/502
+                Write-Host "Syncing winget-pkgs fork..."
+                & "$tempDir\gh\bin\gh.exe" repo sync $(WingetPkgsFork) -b master
+                if ($LASTEXITCODE -ne 0) {
+                  Write-Error "Failed to sync winget-pkgs fork. Exit code: $LASTEXITCODE"
+                  exit $LASTEXITCODE
+                }
+                Write-Host "Fork synced successfully."
                 
                 # Get the installer URLs from the GitHub release
                 $x64MsixUrl = "https://github.com/microsoft/winappcli/releases/download/v$(version)/winappcli_$(version).0_x64.msix"
@@ -262,6 +295,6 @@ extends:
                 
                 # Submit to WinGet repository
                 wingetcreate update Microsoft.WinAppCli `
-                 --version $(version) `
+                  --version $(version) `
                   --urls $x64MsixUrl $arm64MsixUrl `
                   --submit
diff --git a/README.md b/README.md
@@ -41,7 +41,15 @@ Perfect for:
 
 ## 📦 Installation
 
-The easiest way to use the CLI is to download the latest build from GitHub Releases.
+### WinGet
+
+The easiest way to use the CLI is via WinGet (Windows Package Manager). In Terminal, simply run:
+
+`winget install Microsoft.WinAppCLI`
+
+### Download Release Manually
+
+Or, download the latest build from GitHub Releases:
 
 **[👉 Download Latest Build](https://github.com/microsoft/WinAppCli/releases/latest)**
 
@@ -55,7 +63,7 @@ The easiest way to use the CLI is to download the latest build from GitHub Relea
 
 ### Adding to Path
 
-The easiest way to use the CLI globally is to install it via the [MSIX installer](https://github.com/microsoft/WinAppCli/releases/latest).
+The easiest way to use the CLI globally is to install it via WinGet or the [MSIX installer](https://github.com/microsoft/WinAppCli/releases/latest).
 
 You can also add it manually: Windows Search → Edit the system environment variables → Environment Variables → Path → Edit → New → Add the location (folder) of winapp CLI.
 
diff --git a/src/winapp-CLI/WinApp.Cli/Program.cs b/src/winapp-CLI/WinApp.Cli/Program.cs
@@ -76,6 +76,13 @@ static async Task<int> Main(string[] args)
 
             CommandCompletedEvent.Log(parseResult.CommandResult, returnCode);
 
+            if (args.Length == 0)
+            {
+                // Temporary special case: If no arguments are provided, return 0 to indicate success.
+                // This is because winget's validation currently doesn't like us returning failure here.
+                returnCode = 0;
+            }
+
             return returnCode;
         }
         catch (Exception ex)
diff --git a/src/winapp-CLI/WinApp.Cli/Telemetry/Events/EventBase.cs b/src/winapp-CLI/WinApp.Cli/Telemetry/Events/EventBase.cs
@@ -10,7 +10,7 @@ public class PrivacyProduct
 {
     public static readonly UInt16
 #pragma warning disable CA1707 // Identifiers should not contain underscores
-    WIN_APP_DEV_CLI = 8;
+    WIN_APP_DEV_CLI = 9;
 #pragma warning restore CA1707 // Identifiers should not contain underscores
 };
 
diff --git a/version.json b/version.json
@@ -1,3 +1,3 @@
 {
-  "version": "0.1.5"
+  "version": "0.1.8"
 }

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public class PrivacyProduct`
`10`	`10`	`{`
`11`	`11`	`public static readonly UInt16`
`12`	`12`	`#pragma warning disable CA1707 // Identifiers should not contain underscores`
`13`		`- WIN_APP_DEV_CLI = 8;`
	`13`	`+ WIN_APP_DEV_CLI = 9;`
`14`	`14`	`#pragma warning restore CA1707 // Identifiers should not contain underscores`
`15`	`15`	`};`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "version": "0.1.5"`
	`2`	`+ "version": "0.1.8"`
`3`	`3`	`}`