Default to auto-detected 64-bit MSBuild on 64-bit hosts (breaking change, v4)

Fixes #88

- msbuild-architecture no longer hardcodes a default of "x86". When the
  input is left unspecified, the action now auto-detects: it prefers x64
  when running on a 64-bit machine and the resolved VS/MSBuild install is
  17.0+ (VS 2022+), and falls back to x86 otherwise. An explicit
  msbuild-architecture value is always respected.
- Extracted resolveMSBuildArchitecture()/parseMajorVersion() as pure,
  exported helpers and added jest tests covering the resolution matrix.
- Bumped package.json version to 4.0.0 (breaking change/new major version).
- Updated action.yml input description and README (usage examples now
  reference @v4, new "Breaking Changes in v4" section, and the
  architecture-selection docs rewritten to describe auto-detection).
- Rebuilt dist/index.js via ncc.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    groups:
+      github-actions:
+        patterns: ["*"]
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7

.github/workflows/test.yml

@@ -4,26 +4,25 @@ on:
     branches:
       - dev
     paths-ignore:
-      - '*.md'
+      - "*.md"
   push:
     branches:
       - dev
     paths-ignore:
-      - '*.md'
+      - "*.md"
   workflow_dispatch:
-    branches:
-      - dev
-      - arm64
-      - master
-    paths-ignore:
-      - '*.md'
-  
 
 jobs:
   build:
-    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        runner:
+          - windows-latest
+          - windows-2025-vs2026
+    runs-on: ${{ matrix.runner }}
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
 
       - name: Setup MSBuild (vswhere-path)
         id: setup_msbuild_explicit
@@ -39,31 +38,42 @@ jobs:
         id: setup_msbuild_fallback
         uses: ./
         env:
-        PATH: ''
+          PATH: ""
 
       - name: Setup MSBuild (x64)
-      if: always()
+        if: runner.arch == 'X64'
         id: setup_msbuild_path_x64
         uses: ./
         with:
           vs-prerelease: true
-        msbuild-architecture: 'x64'
+          msbuild-architecture: "x64"
 
       - name: Setup MSBuild (arm64)
-      if: always()
+        if: runner.arch == 'ARM64'
-      id: setup_msbuild_path_arm
+        id: setup_msbuild_path_arm64
         uses: ./
         with:
           vs-prerelease: true
-        msbuild-architecture: 'arm64'
+          msbuild-architecture: "arm64"
 
-    - name: echo msbuild path
+      - name: Write MSBuild summary
+        if: always()
+        shell: pwsh
         run: |
-        echo "vswhere-path: ${{ steps.setup_msbuild_explicit.outputs.msbuildPath }}"
+          @"
-        echo "PATH: ${{ steps.setup_msbuild_path.outputs.msbuildPath }}"
+          ## MSBuild setup summary
-        echo "ARM PATH: ${{ steps.setup_msbuild_path_arm.outputs.msbuildPath }}"
+
-        echo "ARM PATH: ${{ steps.setup_msbuild_path_x64.outputs.msbuildPath }}"
+          - Runner label: `${{ matrix.runner }}`
-        echo "Fallback: ${{ steps.setup_msbuild_fallback.outputs.msbuildPath }}"
+          - Runner architecture: `${{ runner.arch }}`
+
+          | Probe | msbuildPath |
+          | --- | --- |
+          | vswhere-path | ${{ steps.setup_msbuild_explicit.outputs.msbuildPath || 'N/A' }} |
+          | PATH | ${{ steps.setup_msbuild_path.outputs.msbuildPath || 'N/A' }} |
+          | Fallback | ${{ steps.setup_msbuild_fallback.outputs.msbuildPath || 'N/A' }} |
+          | x64 | ${{ steps.setup_msbuild_path_x64.outputs.msbuildPath || 'N/A' }} |
+          | arm64 | ${{ steps.setup_msbuild_path_arm64.outputs.msbuildPath || 'N/A' }} |
+          "@ | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Encoding utf8 -Append
 
       - name: echo MSBuild
         run: msbuild -version

README.md

@@ -2,13 +2,28 @@
 
 This action will help discover where the `MSBuild` tool is and automatically add it to the `PATH` environment variables for you so future steps in your Actions workflow can just initiate `msbuild` commands without knowing the full path.
 
+> [!IMPORTANT]
 > Please note this tool does NOT add other Visual Studio tools (like VSTest, cl, cmake, or others) to `PATH`
 
+## Breaking Changes in v4
+
+Starting with `v4`, the default value of `msbuild-architecture` is no longer always `x86`. When
+`msbuild-architecture` is not explicitly specified, the action now **auto-detects** the best
+architecture:
+
+- `x64` when running on a 64-bit machine **and** the resolved Visual Studio/MSBuild install is
+  version 17.0 or later (Visual Studio 2022+, which ships a native 64-bit MSBuild).
+- `x86` otherwise (older Visual Studio versions, or 32-bit hosts), matching the previous behavior.
+
+If you explicitly set `msbuild-architecture` (e.g. `x86`, `x64`, or `arm64`), that value is always
+respected and this auto-detection does not apply. If your workflow depends on always getting the
+32-bit MSBuild by default, set `msbuild-architecture: x86` explicitly.
+
 ## Example Usage
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.1
+  uses: microsoft/setup-msbuild@v4
 
 - name: Build app for release
   run: msbuild src\YourProjectFile.csproj -t:rebuild -verbosity:diag -property:Configuration=Release
@@ -16,7 +31,7 @@ This action will help discover where the `MSBuild` tool is and automatically add
 
 ## Runners and included software
 
-This action is intended to be used within the GitHub Actions workflows using the model of 'runners' either hosted (provided by GitHub) or self-hosted (provided by you). The version and parameters you specify below are going to be scoped to what software actually exists on the runner image being used. For example, hosted runner images from GitHub typically do NOT have pre-release versions of Visual Studio on them so using `vs-prerelease` parameter noted below may not have intended effect when using hosted runners. The software included for GitHub-hosted runner iamges can always be found here: <https://github.com/actions/runner-images> which also includes information on when/how software on hosted images gets updated.
+This action is intended to be used within the GitHub Actions workflows using the model of 'runners' either hosted (provided by GitHub) or self-hosted (provided by you). The version and parameters you specify below are going to be scoped to what software actually exists on the runner image being used. For example, hosted runner images from GitHub typically do NOT have pre-release versions of Visual Studio on them so using `vs-prerelease` parameter noted below may not have intended effect when using hosted runners. The software included for GitHub-hosted runner images can always be found here: <https://github.com/actions/runner-images> which also includes information on when/how software on hosted images gets updated.
 
 ## Optional Parameters
 
@@ -28,7 +43,7 @@ You may have a situation where your Actions runner has multiple versions of Visu
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.1
+  uses: microsoft/setup-msbuild@v4
   with:
     vs-version: '[16.4,16.5)'
 ```
@@ -41,18 +56,22 @@ If you need your Actions runner to target a pre-release version of Visual Studio
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.1
+  uses: microsoft/setup-msbuild@v4
   with:
     vs-prerelease: true
 ```
 
 ### Specifying MSBuild architecture (optional)
 
-By default the action will use the x86 architecture for MSBuild, but it is possible to target the x64 versions instead. Simply add the `msbuild-architecture` input. Valid input values are `x86` (default), `x64`, and `arm64`. Note that the success of these will rely on the runner OS.
+By default (as of `v4`), the action auto-detects the preferred MSBuild architecture: it uses `x64`
+when running on a 64-bit machine with Visual Studio/MSBuild 17.0 or later installed, and falls back
+to `x86` otherwise. You can override this by explicitly setting the `msbuild-architecture` input.
+Valid input values are `x86`, `x64`, and `arm64`. Note that the success of these will rely on the
+runner OS.
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.1
+  uses: microsoft/setup-msbuild@v4
   with:
     msbuild-architecture: x64
 ```
@@ -63,7 +82,7 @@ This makes use of the vswhere tool which is a tool delivered by Microsoft to hel
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.1
+  uses: microsoft/setup-msbuild@v4
   with:
     vswhere-path: 'C:\path\to\your\tools\'
 ```

__tests__/main.test.ts

@@ -0,0 +1,54 @@
+import {
+  MIN_VS_VERSION_FOR_X64,
+  parseMajorVersion,
+  resolveMSBuildArchitecture
+} from '../src/main'
+
+describe('parseMajorVersion', () => {
+  it('parses a standard installationVersion string', () => {
+    expect(parseMajorVersion('17.9.34728.123')).toBe(17)
+  })
+
+  it('parses a single-segment version', () => {
+    expect(parseMajorVersion('16')).toBe(16)
+  })
+
+  it('trims whitespace before parsing', () => {
+    expect(parseMajorVersion('  17.0.0.0  ')).toBe(17)
+  })
+
+  it('returns undefined for an empty string', () => {
+    expect(parseMajorVersion('')).toBeUndefined()
+  })
+
+  it('returns undefined for a non-numeric string', () => {
+    expect(parseMajorVersion('not-a-version')).toBeUndefined()
+  })
+})
+
+describe('resolveMSBuildArchitecture', () => {
+  it('always respects an explicit architecture, regardless of OS/version', () => {
+    expect(resolveMSBuildArchitecture('x86', true, 17)).toBe('x86')
+    expect(resolveMSBuildArchitecture('x64', false, 15)).toBe('x64')
+    expect(resolveMSBuildArchitecture('arm64', true, 17)).toBe('arm64')
+  })
+
+  it('defaults to x64 on a 64-bit host with VS/MSBuild 17+', () => {
+    expect(resolveMSBuildArchitecture('', true, MIN_VS_VERSION_FOR_X64)).toBe(
+      'x64'
+    )
+    expect(resolveMSBuildArchitecture('', true, 18)).toBe('x64')
+  })
+
+  it('defaults to x86 on a 64-bit host with VS/MSBuild older than 17', () => {
+    expect(resolveMSBuildArchitecture('', true, 16)).toBe('x86')
+  })
+
+  it('defaults to x86 on a non-64-bit host even with VS/MSBuild 17+', () => {
+    expect(resolveMSBuildArchitecture('', false, 17)).toBe('x86')
+  })
+
+  it('defaults to x86 when the VS/MSBuild version could not be determined', () => {
+    expect(resolveMSBuildArchitecture('', true, undefined)).toBe('x86')
+  })
+})

action.yml

@@ -15,13 +15,12 @@ inputs:
     description: "Enable searching for pre-release versions of Visual Studio/MSBuild"
     required: false
   msbuild-architecture:
-    description: 'The preferred processor architecture of MSBuild. Can be either "x86", "x64", or "arm64". "x64" is only available from Visual Studio version 17.0 and later.'
+    description: 'The preferred processor architecture of MSBuild. Can be either "x86", "x64", or "arm64". "x64" is only available from Visual Studio version 17.0 and later. If left unspecified, the action auto-detects the best option: "x64" on 64-bit machines when a Visual Studio/MSBuild 17.0+ install is found, otherwise "x86".'
     required: false
-    default: "x86"
 outputs:
   msbuildPath:
     description: "The resulting location of msbuild for your inputs"
 
 runs:
-  using: "node20"
+  using: "node24"
   main: "dist/index.js"

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "setup-msbuild",
-  "version": "1.3.2",
+  "version": "3.0.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "setup-msbuild",
-      "version": "1.3.2",
+      "version": "3.0.0",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.0",
@@ -17,7 +17,7 @@
         "@types/jest": "^24.0.23",
         "@types/node": "^12.12.25",
         "@typescript-eslint/parser": "^2.8.0",
-        "@zeit/ncc": "^0.20.5",
+        "@vercel/ncc": "^0.38.4",
         "eslint": "^5.16.0",
         "eslint-plugin-github": "^2.0.0",
         "eslint-plugin-jest": "^22.21.0",
@@ -789,12 +789,12 @@
         }
       }
     },
-    "node_modules/@zeit/ncc": {
+    "node_modules/@vercel/ncc": {
-      "version": "0.20.5",
+      "version": "0.38.4",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.20.5.tgz",
+      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.4.tgz",
-      "integrity": "sha512-XU6uzwvv95DqxciQx+aOLhbyBx/13ky+RK1y88Age9Du3BlA4mMPCy13BGjayOrrumOzlq1XV3SD/BWiZENXlw==",
+      "integrity": "sha512-8LwjnlP39s08C08J5NstzriPvW1SP8Zfpp1BvC2sI35kPeZnHfxVkCwu4/+Wodgnd60UtT1n8K8zw+Mp7J9JmQ==",
-      "deprecated": "@zeit/ncc is no longer maintained. Please use @vercel/ncc instead.",
       "dev": true,
+      "license": "MIT",
       "bin": {
         "ncc": "dist/ncc/cli.js"
       }
@@ -8845,10 +8845,10 @@
         "tsutils": "^3.17.1"
       }
     },
-    "@zeit/ncc": {
+    "@vercel/ncc": {
-      "version": "0.20.5",
+      "version": "0.38.4",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.20.5.tgz",
+      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.4.tgz",
-      "integrity": "sha512-XU6uzwvv95DqxciQx+aOLhbyBx/13ky+RK1y88Age9Du3BlA4mMPCy13BGjayOrrumOzlq1XV3SD/BWiZENXlw==",
+      "integrity": "sha512-8LwjnlP39s08C08J5NstzriPvW1SP8Zfpp1BvC2sI35kPeZnHfxVkCwu4/+Wodgnd60UtT1n8K8zw+Mp7J9JmQ==",
       "dev": true
     },
     "abab": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-msbuild",
-  "version": "2.0.0",
+  "version": "4.0.0",
   "private": true,
   "description": "Helps set up specific MSBuild tool into PATH for later usage.",
   "main": "lib/main.js",
@@ -9,7 +9,7 @@
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
     "lint": "eslint src/**/*.ts",
-    "pack": "ncc build",
+    "pack": "ncc build lib/main.js -o dist",
     "test": "jest",
     "all": "npm run build && npm run format && npm run lint && npm run pack"
   },
@@ -36,7 +36,7 @@
     "@types/jest": "^24.0.23",
     "@types/node": "^12.12.25",
     "@typescript-eslint/parser": "^2.8.0",
-    "@zeit/ncc": "^0.20.5",
+    "@vercel/ncc": "^0.38.4",
     "eslint": "^5.16.0",
     "eslint-plugin-github": "^2.0.0",
     "eslint-plugin-jest": "^22.21.0",

src/main.ts

@@ -1,6 +1,7 @@
 import * as core from '@actions/core'
 import * as exec from '@actions/exec'
 import * as fs from 'fs'
+import * as os from 'os'
 import * as path from 'path'
 import * as io from '@actions/io'
 import {ExecOptions} from '@actions/exec/lib/interfaces'
@@ -9,13 +10,56 @@ const IS_WINDOWS = process.platform === 'win32'
 const VS_VERSION = core.getInput('vs-version') || 'latest'
 const VSWHERE_PATH = core.getInput('vswhere-path')
 const ALLOW_PRERELEASE = core.getInput('vs-prerelease') || 'false'
-let MSBUILD_ARCH = core.getInput('msbuild-architecture') || 'x86'
+const MSBUILD_ARCH_INPUT = core.getInput('msbuild-architecture')
+let MSBUILD_ARCH = MSBUILD_ARCH_INPUT
+
+// The minimum Visual Studio/MSBuild major version that ships a native x64 MSBuild.exe
+export const MIN_VS_VERSION_FOR_X64 = 17
+
+// Determines the effective MSBuild architecture to use.
+// If the user explicitly specified `msbuild-architecture`, that choice is always respected.
+// Otherwise (breaking change as of v4), the action auto-detects and prefers x64 when
+// running on a 64-bit OS and the resolved VS/MSBuild installation is version 17.0 or later.
+// If the VS version can't be determined, or the host isn't 64-bit, it falls back to x86.
+export function resolveMSBuildArchitecture(
+  explicitArch: string,
+  isWindows64Bit: boolean,
+  vsMajorVersion: number | undefined
+): string {
+  if (explicitArch) {
+    return explicitArch
+  }
+
+  if (
+    isWindows64Bit &&
+    vsMajorVersion !== undefined &&
+    vsMajorVersion >= MIN_VS_VERSION_FOR_X64
+  ) {
+    return 'x64'
+  }
+
+  return 'x86'
+}
+
+// Parses the major version number out of a vswhere `installationVersion` string
+// such as "17.9.34728.123". Returns undefined if it cannot be parsed.
+export function parseMajorVersion(
+  installationVersion: string
+): number | undefined {
+  const match = installationVersion.trim().match(/^(\d+)/)
+  if (!match) {
+    return undefined
+  }
+  const major = parseInt(match[1], 10)
+  return isNaN(major) ? undefined : major
+}
 
 // if a specific version of VS is requested
-let VSWHERE_EXEC = '-products * -requires Microsoft.Component.MSBuild -property installationPath -latest '
+let VSWHERE_EXEC =
+  '-products * -requires Microsoft.Component.MSBuild -property installationPath -latest '
 if (ALLOW_PRERELEASE === 'true') {
   VSWHERE_EXEC += ' -prerelease '
- }
+}
 
 if (VS_VERSION !== 'latest') {
   VSWHERE_EXEC += `-version "${VS_VERSION}" `
@@ -64,6 +108,39 @@ async function run(): Promise<void> {
 
     core.debug(`Full tool exe: ${vswhereToolExe}`)
 
+    // if the user did not explicitly specify an architecture, auto-detect the
+    // preferred architecture based on the host OS and the resolved VS/MSBuild version
+    if (!MSBUILD_ARCH_INPUT) {
+      let vsMajorVersion: number | undefined
+      const versionOptions: ExecOptions = {}
+      versionOptions.listeners = {
+        stdout: (data: Buffer) => {
+          const installationVersion = data.toString().trim()
+          core.debug(`Found installation version: ${installationVersion}`)
+          const parsed = parseMajorVersion(installationVersion)
+          if (parsed !== undefined) {
+            vsMajorVersion = parsed
+          }
+        }
+      }
+
+      const versionExec = VSWHERE_EXEC.replace(
+        '-property installationPath',
+        '-property installationVersion'
+      )
+      await exec.exec(`"${vswhereToolExe}" ${versionExec}`, [], versionOptions)
+
+      const isWindows64Bit = os.arch() === 'x64' || os.arch() === 'arm64'
+      MSBUILD_ARCH = resolveMSBuildArchitecture(
+        MSBUILD_ARCH_INPUT,
+        isWindows64Bit,
+        vsMajorVersion
+      )
+      core.info(
+        `Auto-detected msbuild-architecture: ${MSBUILD_ARCH} (os.arch=${os.arch()}, vsMajorVersion=${vsMajorVersion})`
+      )
+    }
+
     let foundToolPath = ''
     const options: ExecOptions = {}
     options.listeners = {
@@ -118,6 +195,24 @@ async function run(): Promise<void> {
       return
     }
 
+    core.info(`Found MSBuild tool path: ${foundToolPath}`)
+    core.info(`Using MSBuild architecture: ${MSBUILD_ARCH}`)
+
+    // try to get the MSBuild version for diagnostic purposes; a failure here shouldn't fail the action
+    try {
+      let msbuildVersion = ''
+      const versionOptions: ExecOptions = {}
+      versionOptions.listeners = {
+        stdout: (data: Buffer) => {
+          msbuildVersion += data.toString()
+        }
+      }
+      await exec.exec(`"${foundToolPath}" -version -nologo`, [], versionOptions)
+      core.info(`Found MSBuild version: ${msbuildVersion.trim()}`)
+    } catch (error) {
+      core.debug(`Unable to determine MSBuild version: ${error.message}`)
+    }
+
     // extract the folder location for the tool
     const toolFolderPath = path.dirname(foundToolPath)
 
@@ -126,7 +221,7 @@ async function run(): Promise<void> {
 
     // add tool path to PATH
     core.addPath(toolFolderPath)
-    core.debug(`Tool path added to PATH: ${toolFolderPath}`)
+    core.info(`Tool path added to PATH: ${toolFolderPath}`)
   } catch (error) {
     core.setFailed(error.message)
   }