[skip ci] Merge pull request #129 from GeckoEidechse/fix/readme-typo

Fix small typo in README.md

.github/workflows/test.yml

@@ -10,12 +10,20 @@ on:
       - dev
     paths-ignore:
       - '*.md'
+  workflow_dispatch:
+    branches:
+      - dev
+      - arm64
+      - master
+    paths-ignore:
+      - '*.md'
+  
 
 jobs:
   build:
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Setup MSBuild (vswhere-path)
       id: setup_msbuild_explicit
@@ -33,11 +41,29 @@ jobs:
       env:
         PATH: ''
 
+    - name: Setup MSBuild (x64)
+      if: always()
+      id: setup_msbuild_path_x64
+      uses: ./
+      with:
+        vs-prerelease: true
+        msbuild-architecture: 'x64'
+
+    - name: Setup MSBuild (arm64)
+      if: always()
+      id: setup_msbuild_path_arm
+      uses: ./
+      with:
+        vs-prerelease: true
+        msbuild-architecture: 'arm64'
+
     - name: echo msbuild path
       run: |
         echo "vswhere-path: ${{ steps.setup_msbuild_explicit.outputs.msbuildPath }}"
         echo "PATH: ${{ steps.setup_msbuild_path.outputs.msbuildPath }}"
+        echo "ARM PATH: ${{ steps.setup_msbuild_path_arm.outputs.msbuildPath }}"
+        echo "ARM PATH: ${{ steps.setup_msbuild_path_x64.outputs.msbuildPath }}"
         echo "Fallback: ${{ steps.setup_msbuild_fallback.outputs.msbuildPath }}"
 
     - name: echo MSBuild
-      run: msbuild -version
+      run: msbuild -version

README.md

@@ -1,39 +1,80 @@
 # microsoft/setup-msbuild
-You know how handy that 'Visual Studio Developer Command Prompt' is on your local machine?  And how it adds several things to `PATH` to allow you to just issue commands like `msbuild` or otherwise?  Use this action to setup similar flexibility in your Windows-based GitHub Actions runners.  This will let you discover where those tool paths are and automatically add them to the `PATH` environment variables for you so future steps in your Actions workflow can just initiate commands without knowing the full path.
 
-## Usage
+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`
+
+## Example Usage
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.0.1
+  uses: microsoft/setup-msbuild@v2
+
+- name: Build app for release
+  run: msbuild src\YourProjectFile.csproj -t:rebuild -verbosity:diag -property:Configuration=Release
 ```
 
-## Specifying specific versions of Visual Studio
+## 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 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
+
+There are a few additional parameters that can be set if you need them. These are optional and should only be set if you know that you need them or what you are doing.
+
+### Specifying specific versions of Visual Studio (optional)
+
 You may have a situation where your Actions runner has multiple versions of Visual Studio and you need to find a specific version of the tool.  Simply add the `vs-version` input to specify the range of versions to find.  If looking for a specific version, specify the minimum and maximum versions as shown in the example below, which will look for just 16.4.
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.0.1
-    with:
-      vs-version: '[16.4,16.5)'
+  uses: microsoft/setup-msbuild@v2
+  with:
+    vs-version: '[16.4,16.5)'
 ```
 
 The syntax is the same used for Visual Studio extensions, where square brackets like "[" mean inclusive, and parenthesis like "(" mean exclusive. A comma is always required, but eliding the minimum version looks for all older versions and eliding the maximum version looks for all newer versions. See the [vswhere wiki](https://github.com/microsoft/vswhere/wiki) for more details.
 
-## How does this work?
-This makes use of the vswhere tool which is a tool is delivered by Microsoft to help in identifying Visual Studio installs and various components.  This tool is installed on the hosted Windows runners for GitHub Actions.  If you are using a self-hosted runner, you either need to make sure vswhere.exe is in your agent's PATH or specify a full path to the location using:
+### Use pre-release versions of Visual Studio (optional)
+
+If you need your Actions runner to target a pre-release version of Visual Studio, simply add the `vs-prerelease` input.  This is necessary if you want to run an action on a virtual environment that contains a pre-release version of Visual Studio or self-hosted images that you may have that also have pre-release versions of Visual Studio installed.
 
 ```yml
 - name: Add msbuild to PATH
-  uses: microsoft/setup-msbuild@v1.0.1
-    with:
-      vswhere-path: 'C:\path\to\your\tools\'
+  uses: microsoft/setup-msbuild@v2
+  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.
+
+```yml
+- name: Add msbuild to PATH
+  uses: microsoft/setup-msbuild@v2
+  with:
+    msbuild-architecture: x64
+```
+
+## How does this work?
+
+This makes use of the vswhere tool which is a tool delivered by Microsoft to help in identifying Visual Studio installs and various components.  This tool is installed on the hosted Windows runners for GitHub Actions.  If you are using a self-hosted runner, you either need to make sure vswhere.exe is in your agent's PATH or specify a full path to the location using:
+
+```yml
+- name: Add msbuild to PATH
+  uses: microsoft/setup-msbuild@v2
+  with:
+    vswhere-path: 'C:\path\to\your\tools\'
 ```
 
 ## Notes on arguments
-While the Action enables you to specify a `vswhere` path as well as a `vs-version`, these are more advanced options and when using GitHub-hosted runners you should not need these and is recommended you don't specify them.  Using these require you to fully understand the runner environment, updates to the tools on the runner, and can cause failures if you are out of sync.  For GitHub-hosted runners, omitting these arguments is the preferred usage.
+
+While the Action enables you to specify a `vswhere` path as well as a `vs-version`, these are more advanced options and when using GitHub-hosted runners you should not need these and is recommended you don't specify them as they are optional.  Using these require you to fully understand the runner environment, updates to the tools on the runner, and can cause failures if you are out of sync.  For GitHub-hosted runners, omitting these arguments is the preferred usage.
 
 ## Building this repo
+
 As with most GitHub Actions, this requires NodeJS development tools.  After installing NodeJS, you can build this by executing:
 
 ```bash
@@ -45,13 +86,14 @@ npm run pack
 which will modify/create the /dist folder with the final index.js output
 
 # Credits
+
 Thank you to [Warren Buckley](https://github.com/warrenbuckley) for being a core contributor to this Action for the benefit of all developers!
 
 # Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
 
 When you submit a pull request, a CLA bot will automatically determine whether you need to provide
 a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions

action-types.yml

@@ -0,0 +1,18 @@
+# See https://github.com/krzema12/github-actions-typing
+inputs:
+  vswhere-path:
+    type: string
+  vs-version:
+    type: string
+  vs-prerelease:
+    type: boolean
+  msbuild-architecture:
+    type: enum
+    name: Architecture
+    allowed-values:
+    - x86
+    - x64
+    - arm64
+outputs:
+  msbuildPath:
+    type: string

action.yml

@@ -1,20 +1,27 @@
-name: 'setup-msbuild'
-description: 'Helps set up MSBuild into PATH for later usage.'
-author: 'Microsoft'
+name: "setup-msbuild"
+description: "Helps set up MSBuild into PATH for later usage."
+author: "Microsoft"
 branding:
   color: purple
   icon: terminal
 inputs:
   vswhere-path:
     required: false
-    description: 'Folder location of where vswhere.exe is located if a self-hosted agent'
+    description: "Folder location of where vswhere.exe is located if a self-hosted agent"
   vs-version:
-    description: 'Version of Visual Studio to search; defaults to latest if not specified'
+    description: "Version of Visual Studio to search; defaults to latest if not specified"
     required: false
+  vs-prerelease:
+    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.'
+    required: false
+    default: "x86"
 outputs:
   msbuildPath:
-    description: 'The resulting location of msbuild for your inputs'
+    description: "The resulting location of msbuild for your inputs"
 
 runs:
-  using: 'node12'
-  main: 'dist/index.js'
+  using: "node20"
+  main: "dist/index.js"

building-release.md

@@ -0,0 +1,29 @@
+# Building a release
+This is a quick document to walk through the process of building and releasing.
+
+## Building the version
+- Create a new branch [vMajor.Minor.Revision] for the version from `dev`
+- Make changes in the new branch
+- Build the branch/package
+    - `npm install`
+    - `npm run build`
+    - `npm run pack`
+- Prune the dependencies to only production
+    - `npm prune --production`
+- Uncomment `node_modules` in `.gitignore` **for this branch only**
+- Commit the changes to the branch
+- Push the new version branch
+    - `git push origin [vMajor.Minor.Revision]`
+
+## Releasing the new version
+- Draft a new release to [vMajor.Minor.Revision]
+
+## Update major version tag
+If the update is non-breaking and the major version binding you can update the version tag to make the new release available to those binding to the major version tag ([GitHub Actions Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)).
+
+Do this from the version branch after push (using a v1 tag as example only here)
+
+```
+git tag -fa v1 -m "Update v1 tag"
+git push origin v1 --force
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-msbuild",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "private": true,
   "description": "Helps set up specific MSBuild tool into PATH for later usage.",
   "main": "lib/main.js",
@@ -28,7 +28,7 @@
   "author": "Microsoft",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.0",
+    "@actions/core": "^1.10.0",
     "@actions/exec": "^1.0.3",
     "@actions/tool-cache": "^1.3.0"
   },
@@ -47,4 +47,4 @@
     "ts-jest": "^24.2.0",
     "typescript": "^3.6.4"
   }
-}
+}

src/main.ts

@@ -8,9 +8,15 @@ import {ExecOptions} from '@actions/exec/lib/interfaces'
 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'
 
 // if a specific version of VS is requested
 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}" `
 }
@@ -65,25 +71,42 @@ async function run(): Promise<void> {
         const installationPath = data.toString().trim()
         core.debug(`Found installation path: ${installationPath}`)
 
-        let toolPath = path.join(
-          installationPath,
-          'MSBuild\\Current\\Bin\\MSBuild.exe'
-        )
-
-        core.debug(`Checking for path: ${toolPath}`)
-        if (!fs.existsSync(toolPath)) {
-          toolPath = path.join(
+        // x64 and arm64 only exist in one possible location, so no fallback probing
+        if (MSBUILD_ARCH === 'x64' || MSBUILD_ARCH === 'arm64') {
+          // x64 is actually amd64 so change to that
+          if (MSBUILD_ARCH === 'x64') {
+            MSBUILD_ARCH = 'amd64'
+          }
+          let toolPath = path.join(
             installationPath,
-            'MSBuild\\15.0\\Bin\\MSBuild.exe'
+            `MSBuild\\Current\\Bin\\${MSBUILD_ARCH}\\MSBuild.exe`
           )
-
           core.debug(`Checking for path: ${toolPath}`)
           if (!fs.existsSync(toolPath)) {
             return
           }
-        }
+          foundToolPath = toolPath
+        } else {
+          let toolPath = path.join(
+            installationPath,
+            'MSBuild\\Current\\Bin\\MSBuild.exe'
+          )
 
-        foundToolPath = toolPath
+          core.debug(`Checking for path: ${toolPath}`)
+          if (!fs.existsSync(toolPath)) {
+            toolPath = path.join(
+              installationPath,
+              'MSBuild\\15.0\\Bin\\MSBuild.exe'
+            )
+
+            core.debug(`Checking for path: ${toolPath}`)
+            if (!fs.existsSync(toolPath)) {
+              return
+            }
+          }
+
+          foundToolPath = toolPath
+        }
       }
     }