Merge pull request #97 from microsoft/alzollin/publishNpm

Added ESRPRelease task to publish npm package.

Author: azchohfi

.pipelines/release.yml

@@ -24,6 +24,7 @@ parameters:
       akvName: $(SigningAKVName)
       authCertName: $(SigningAuthCertName)
       signCertName: $(SigningSignCertName)
+      signTTSCertName: $(SigningSignTTSCertName)
 
 extends:
   template: v1/1ES.Official.PipelineTemplate.yml@1esPipelines
@@ -86,7 +87,7 @@ extends:
                 Write-Host "##vso[task.setvariable variable=version;isOutput=true]$fullVersion"
 
     - stage: Release
-      displayName: Create GitHub Pre-release
+      displayName: Create GitHub Release
       dependsOn: Build
       variables:
         version: $[ stageDependencies.Build.Build.outputs['SetMeta.version'] ]
@@ -97,7 +98,7 @@ extends:
           image: windows-latest
           os: windows
           hostArchitecture: amd64
-        displayName: GitHub Pre-release
+        displayName: GitHub Release
         templateContext:
           type: releaseJob
           isProduction: true
@@ -117,44 +118,48 @@ extends:
             inputs:
               rootFolderOrFile: $(Pipeline.Workspace)/cli-binaries/win-x64
               includeRootFolder: false
-              archiveFile: $(Pipeline.Workspace)/winappcli-x64.zip
+              archiveFile: $(Pipeline.Workspace)/winappcli-$(version)-x64.zip
 
           - task: ArchiveFiles@2
             displayName: Archive CLI binaries - arm64
             inputs:
               rootFolderOrFile: $(Pipeline.Workspace)/cli-binaries/win-arm64
               includeRootFolder: false
-              archiveFile: $(Pipeline.Workspace)/winappcli-arm64.zip
+              archiveFile: $(Pipeline.Workspace)/winappcli-$(version)-arm64.zip
 
           - task: GitHubRelease@1
-            displayName: "Create GitHub Pre-release"
+            displayName: "Create GitHub Release"
             inputs:
               gitHubConnection: 'github-service-connection'
               repositoryName: 'microsoft/winappcli'
               action: 'create'
               target: '$(Build.SourceVersion)'
               tagSource: 'userSpecifiedTag'
               tag: 'v$(version)'
-              title: 'Pre-release v$(version)'
+              title: 'Release v$(version)'
               isPreRelease: true
               assets: |
-                $(Pipeline.Workspace)/winappcli-x64.zip
-                $(Pipeline.Workspace)/winappcli-arm64.zip
+                $(Pipeline.Workspace)/winappcli-*.zip
                 $(Pipeline.Workspace)/msix-packages/*.msix
                 $(Pipeline.Workspace)/npm-package/*.tgz
               assetUploadMode: 'delete'
               addChangeLog: false
               releaseNotesSource: 'inline'
               releaseNotesInline: |
-                🚀 **Automated Pre-release Build**
+                🚀 **Automated Release Build**
 
                 Version: `$(version)`
                 Commit: `$(Build.SourceVersion)`
 
                 ## 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
+
                 ### 📦 Standalone CLI Binaries
-                1. Download `winappcli-x64.zip` for x64 or `winappcli-arm64.zip` for ARM64
+                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`
 
@@ -164,5 +169,26 @@ extends:
                 ```
 
                 ## What's Included
+                - ✅ MSIX installer packages (x64 and ARM64)
                 - ✅ Standalone CLI binaries (x64 and ARM64)
-                - ✅ NPM package for NodeJS/Electron integration
+                - ✅ NPM package for NodeJS/Electron integration
+
+          # Commented out ESRP release to npm for now
+          # - ${{ if eq(parameters.DoEsrp, 'true') }}:
+          #   - task: EsrpRelease@10
+          #     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: 'alzollin@microsoft.com'
+          #       approvers: 'alzollin@microsoft.com'
+          #       serviceendpointurl: 'https://api.esrp.microsoft.com'
+          #       mainpublisher: 'winappcli'
+          #       domaintenantid: ${{ parameters.signingIdentity.tenantId }}

.pipelines/templates/build.yaml

@@ -15,7 +15,7 @@ steps:
   inputs:
     pwsh: true
     filePath: $(System.DefaultWorkingDirectory)\scripts\build-cli.ps1
-    arguments: "-Stable:$${{ parameters.stable }} -SkipMsix"
+    arguments: "-Stable:$${{ parameters.stable }} -SkipNpm -SkipMsix"
 - ${{ if eq(parameters['DoEsrp'], 'true') }}:
   - task: EsrpCodeSigning@5
     displayName: Code Sign ESRP - CLI
@@ -55,6 +55,12 @@ steps:
                 "ToolVersion": "1.0"
             }
         ]
+- task: PowerShell@2
+  displayName: Package NPM
+  inputs:
+    pwsh: true
+    filePath: $(System.DefaultWorkingDirectory)\scripts\package-npm.ps1
+    arguments: "-Stable:$${{ parameters.stable }}"
 - task: PowerShell@2
   displayName: Bundle MSIX Packages
   inputs:

README.md

@@ -47,8 +47,8 @@ The easiest way to use the CLI is to download the latest build from GitHub Relea
 
 | Package | Description | Use Case |
 |---------|-------------|----------|
-| **`winapp_[platform]-[version].msix`** | 📦 MSIX Installer | Easy to install, automatically added to path, great for general usage |
-| **`winappcli-[platform].zip`** | 📦 Standalone Binaries | Portable, no install needed - great for CI/CD |
+| **`winappcli_[version]_[platform].msix`** | 📦 MSIX Installer | Easy to install, automatically added to path, great for general usage |
+| **`winappcli-[version]-[platform].zip`** | 📦 Standalone Binaries | Portable, no install needed - great for CI/CD |
 | **`microsoft-winappcli-[version].tgz`** | 📚 NPM Package | For Node.js/Electron projects |
 
 ### Adding to Path

scripts/build-cli.ps1

@@ -1,23 +1,27 @@
 #!/usr/bin/env pwsh
 <#
 .SYNOPSIS
-    Build script for Windows App Development CLI, npm package, and MSIX bundle
+    Build script for Windows App Development CLI, npm package, and MSIX packages
 .DESCRIPTION
     This script builds the Windows App Development CLI for both x64 and arm64 architectures,
-    creates the npm package, creates MSIX bundle with distribution package, and 
+    creates the npm package, creates MSIX packages with distribution package, and 
     places all artifacts in an artifacts folder. Run this script from the root of the project.
 .PARAMETER SkipTests
     Skip running unit tests
 .PARAMETER FailOnTestFailure
     Exit with error code if tests fail (default: true, stops build on test failures)
+.PARAMETER SkipNpm
+    Skip npm package creation
 .PARAMETER SkipMsix
-    Skip MSIX bundle creation
+    Skip MSIX packages creation
 .PARAMETER Stable
     Use stable build configuration (default: false, uses prerelease config)
 .EXAMPLE
     .\scripts\build-cli.ps1
 .EXAMPLE
     .\scripts\build-cli.ps1 -SkipTests
+.EXAMPLE
+    .\scripts\build-cli.ps1 -SkipNpm
 .EXAMPLE
     .\scripts\build-cli.ps1 -SkipMsix
 .EXAMPLE
@@ -28,6 +32,7 @@ param(
     [switch]$Clean = $false,
     [switch]$SkipTests = $false,
     [switch]$FailOnTestFailure = $true,
+    [switch]$SkipNpm = $false,
     [switch]$SkipMsix = $false,
     [switch]$Stable = $false
 )
@@ -42,7 +47,6 @@ try
     # Define paths
     $CliSolutionPath = "src\winapp-CLI\winapp.sln"
     $CliProjectPath = "src\winapp-CLI\WinApp.Cli\WinApp.Cli.csproj"
-    $NpmProjectPath = "src\winapp-npm"
     $ArtifactsPath = "artifacts"
     $TestResultsPath = "TestResults"
 
@@ -182,62 +186,29 @@ try
         exit 1
     }
 
-    # Step 6: Prepare npm package
-    Write-Host "[NPM] Preparing npm package..." -ForegroundColor Blue
-
-    # Clean npm bin directory first
-    Push-Location $NpmProjectPath
-    npm run clean
-    if ($LASTEXITCODE -ne 0) {
-        Write-Warning "npm clean failed, continuing..."
-    }
-
-    # Backup original package.json
-    Write-Host "[NPM] Setting package version to $FullVersion..." -ForegroundColor Blue
-    $PackageJsonPath = "package.json"
-    Copy-Item $PackageJsonPath "$PackageJsonPath.backup" -Force
-
-    # Update package.json version temporarily
-    $PackageJson = Get-Content $PackageJsonPath | ConvertFrom-Json
-    $OriginalVersion = $PackageJson.version
-    $PackageJson.version = $FullVersion
-    $PackageJson | ConvertTo-Json -Depth 100 | Set-Content $PackageJsonPath
-
-    # Copy the CLI binaries we just built instead of rebuilding them
-    Write-Host "[NPM] Copying CLI binaries to npm package..." -ForegroundColor Blue
-    $NpmBinPath = "bin"
-    New-Item -ItemType Directory -Path "$NpmBinPath\win-x64" -Force | Out-Null
-    New-Item -ItemType Directory -Path "$NpmBinPath\win-arm64" -Force | Out-Null
-
-    # Copy from our artifacts to npm bin folders
-    Copy-Item "$ProjectRoot\$ArtifactsPath\cli\win-x64\*" "$NpmBinPath\win-x64\" -Recurse -Force
-    Copy-Item "$ProjectRoot\$ArtifactsPath\cli\win-arm64\*" "$NpmBinPath\win-arm64\" -Recurse -Force
-
-    Pop-Location
-
-    # Step 7: Create npm package tarball
-    Write-Host "[PACK] Creating npm package tarball..." -ForegroundColor Blue
-    Push-Location $NpmProjectPath
-    npm pack --pack-destination "..\..\$ArtifactsPath"
-    $PackResult = $LASTEXITCODE
+    # Step 6: Create npm package (optional)
+    if (-not $SkipNpm) {
+        Write-Host ""
+        Write-Host "[NPM] Creating npm package..." -ForegroundColor Blue
+    
+        $PackageNpmScript = Join-Path $PSScriptRoot "package-npm.ps1"
 
-    # Restore original package.json
-    Write-Host "[NPM] Restoring original package.json..." -ForegroundColor Blue
-    if (Test-Path "$PackageJsonPath.backup") {
-        Move-Item "$PackageJsonPath.backup" $PackageJsonPath -Force
-    }
+        & $PackageNpmScript -Version $FullVersion -Stable:$Stable
 
-    if ($PackResult -ne 0) {
-        Write-Error "Failed to create npm package"
-        Pop-Location
-        exit 1
+        if ($LASTEXITCODE -ne 0) {
+            Write-Warning "npm package creation failed, but continuing..."
+        } else {
+            Write-Host "[NPM] npm package created successfully!" -ForegroundColor Green
+        }
+    } else {
+        Write-Host ""
+        Write-Host "[NPM] Skipping npm package creation (use -SkipNpm:`$false to enable)" -ForegroundColor Gray
     }
-    Pop-Location
 
-    # Step 8: Create MSIX bundle (optional)
+    # Step 7: Create MSIX packages (optional)
     if (-not $SkipMsix) {
         Write-Host ""
-        Write-Host "[MSIX] Creating MSIX bundle..." -ForegroundColor Blue
+        Write-Host "[MSIX] Creating MSIX packages..." -ForegroundColor Blue
 
         # Convert npm version format to MSIX format
         if ($Stable) {
@@ -252,16 +223,16 @@ try
         $PackageMsixScript = Join-Path $PSScriptRoot "package-msix.ps1"
         $CliBinariesPath = Join-Path (Join-Path $ProjectRoot $ArtifactsPath) "cli"
 
-        & $PackageMsixScript -CliBinariesPath $CliBinariesPath -Version $MsixVersion -Stable $Stable
+        & $PackageMsixScript -CliBinariesPath $CliBinariesPath -Version $MsixVersion -Stable:$Stable
 
         if ($LASTEXITCODE -ne 0) {
-            Write-Warning "MSIX bundle creation failed, but continuing..."
+            Write-Warning "MSIX packages creation failed, but continuing..."
         } else {
-            Write-Host "[MSIX] MSIX bundle created successfully!" -ForegroundColor Green
+            Write-Host "[MSIX] MSIX packages created successfully!" -ForegroundColor Green
         }
     } else {
         Write-Host ""
-        Write-Host "[MSIX] Skipping MSIX bundle creation (use -SkipMsix:`$false to enable)" -ForegroundColor Gray
+        Write-Host "[MSIX] Skipping MSIX packages creation (use -SkipMsix:`$false to enable)" -ForegroundColor Gray
     }
 
     # Build process complete - all artifacts are ready

scripts/msix-assets/README.md

@@ -1,8 +1,8 @@
 # Windows Development CLI MSIX Installation
 
-This package contains a pre-release development build of the Windows Development CLI MSIX bundle. 
+This package contains a pre-release development build of the Windows Development CLI MSIX packages. 
 
-> **Note:** The MSIX bundle is signed with a dev certificate. This is temporary until we can sign with a proper certificate. Installing via the `install.cmd` script will install the dev certificate on your machine.
+> **Note:** The MSIX packages are signed with a dev certificate. This is temporary until we can sign with a proper certificate. Installing via the `install.cmd` script will install the dev certificate on your machine.
 
 ## Quick Installation
 
@@ -14,7 +14,8 @@ This package contains a pre-release development build of the Windows Development
 
 ## What's Included
 
-- **winapp_[version].msixbundle** - The MSIX bundle with x64 and ARM64 packages
+- **winappcli_[version]_x64.msix** - The MSIX package for x64 architecture
+- **winappcli_[version]_arm64.msix** - The MSIX package for ARM64 architecture
 - **install.cmd** - Double-click installer (easiest method)
 - **install.ps1** - PowerShell installer script (alternative method)