Merge pull request #15 from microsoft/master

Adding remark about arguments in readme
This commit is contained in:
Tim Heuer 2020-04-21 13:21:03 -07:00 committed by GitHub
commit f05df80b32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions

View File

@ -16,7 +16,7 @@ jobs:
id: setup_msbuild id: setup_msbuild
uses: ./ uses: ./
with: with:
vs-version: "[16.4,16.5]" vs-version: "[16.4,16.6]"
- name: echo msbuild path - name: echo msbuild path
run: echo "${{ steps.setup_msbuild.outputs.msbuildPath }}" run: echo "${{ steps.setup_msbuild.outputs.msbuildPath }}"

View File

@ -28,6 +28,9 @@ This makes use of the vswhere tool which is a tool is delivered by Microsoft to
vswhere-path: 'C:\path\to\your\tools\' 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.
## Building this repo ## Building this repo
As with most GitHub Actions, this requires NodeJS development tools. After installing NodeJS, you can build this by executing: As with most GitHub Actions, this requires NodeJS development tools. After installing NodeJS, you can build this by executing: