How to Update MSVC141.yml Scripts on GitHub

Add the MSVC141 Toolset to the updated.yml script.

GitHub Actions YAML Configuration

name: Pull request - Windows
on:
  pull_request:
    paths-ignore:
      - 'Engine/Engine.Android/'
      - 'Mobile/'
jobs:
  build:
    runs-on: windows-2022
    defaults:
      run:
        shell: pwsh
    env:
      DEFAULT_VERSION: v17.4.500
      SolutionDir: ${{ github.workspace }}
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          token: ${{ secrets.RS_GITHUB_TOKEN }}
          submodules: true
      - uses: actions/setup-java@v4
        with:
          distribution: 'temurin'
          java-version: '11'
      - name: Setup MSBuild
        uses: microsoft/setup-msbuild@v1.1
      - name: Install Visual Studio
        uses: microsoft/setup-msbuild@v1.1
        with:
          vs-version: 2019
          msbuild-version: 16.x
      - name: Setup NuGet sources
        uses: extenda/actions/setup-nuget-sources@v0
        with:
          config-file: NuGet.Config
          sources: |
            [{
              "name": "Nexus",
              "source": "https://repo.extendaretail.com/repository/nuget-hosted/",
              "username": "${{ secrets.NEXUS_USERNAME }}",
              "password": "${{ secrets.NEXUS_PASSWORD }}",
              "apikey": "${{ secrets.NUGET_API_KEY }}"
            }]
      - name: Restore NuGet packages
        run: nuget restore POS.sln
      - name: Determine version
        id: ver
        run: .\Build\determine-version.ps1
      - name: Update assemblies
        run: .\Build\update-assemblies.ps1 ${{ steps.ver.outputs.version }} ${{ steps.ver.outputs.full-version }}
      - name: Generate database template
        run: |
          .\Common\Database\AppVeyor\gen-databases.ps1 Common\Database abcDb
          Copy-Item abcDb\Template.db -Destination Common\Database
      - name: Build solution
        run: msbuild POS.sln @Build\WindowsBuildParams.rsp
      - name: Build installation packages
        run: |
          .\Build\exit-on-failure.ps1
          msbuild Installation\Installation.sln @Build\WindowsBuildParams.rsp -p:BuildNumber=${{ steps.ver.outputs.full-version }}
          ExitOnFailure
          Get-ChildItem Installation\Bin\Release
          Rename-Item -Path Installation\Bin\Release\abc.msi -NewName abc-v${{ steps.ver.outputs.full-version }}.msi
          Rename-Item -Path Installation\Bin\Release\abc.exe -NewName abc-v${{ steps.ver.outputs.full-version }}.exe
          Rename-Item -Path Installation\Bin\Release\VRRSSurfaceComponentsEditor.msi -NewName SurfaceComponentsEditor-v${{ steps.ver.outputs.full-version }}.msi
      - name: Generate customization package
        run: .\Common\Database\AppVeyor\gen-customization-zip.ps1 Common\Database ${{ steps.ver.outputs.full-version }}
      - name: Save abc Installer
        uses: actions/upload-artifact@v3
        with:
          name: abcInstaller-v${{ steps.ver.outputs.full-version }}
          path: Installation\Bin\Release\abc-*.msi
      - name: Save abc Setup
        uses: actions/upload-artifact@v3
        with:
          name: abcSetup-v${{ steps.ver.outputs.full-version }}
          path: Installation\Bin\Release\abc-*.exe
      - name: Save Database
        uses: actions/upload-artifact@v3
        with:
          name: Database-v${{ steps.ver.outputs.full-version }}
          path: Common\Database\CustomizationTemplate\*

Verify the Accurate MSVC Toolset in GitHub Operations

A PowerShell Script to Install and Verify MSVC141

$vswherePath = "C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe"
if (-Not (Test-Path $vswherePath)) {
    Write-Error "vswhere.exe not found at $vswherePath"
    exit 1
}
$vsInstallPath = & $vswherePath -latest -products * -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -property installationPath
if (-Not $vsInstallPath) {
    Write-Output "MSVC141 not found. Installing..."
    Start-Process -FilePath "cmd.exe" -ArgumentList "/c start /wait vs_installer.exe --quiet --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --includeRecommended --includeOptional" -Wait
    if ($?) {
        Write-Output "MSVC141 installation completed."
    }
    else {
        Write-Error "Failed to install MSVC141."
        exit 1
    }
} else {
    Write-Output "MSVC141 already installed at $vsInstallPath"
}
exit 0

Frequently Asked Questions and Answers Regarding MSVC Toolset Integration

1. How can I tell the version of Visual Studio to use in GitHub Actions?
2. To specify the preferred Visual Studio version, use vs-version: 2019 in your .yml configuration.
3. vswhere.exe: what is it and why is it used?
4. A tool to find Visual Studio installations and make sure the necessary toolkits are available is called vswhere.exe.
5. How can I program the installation of components that are missing?
6. To execute the installer with the required inputs for unattended installations, use PowerShell's Start-Process command.
7. Why is setting up NuGet sources important?
8. A successful build depends on all project dependencies being resolved, which is ensured by configuring NuGet sources.
9. How can I find out if the MSVC141 toolkit is installed?
10. To confirm the MSVC141 toolset installation path, use vswhere.exe in a script.
11. What does msbuild-version: 16.x specify?
12. It indicates the version of MSBuild should be used in order to ensure that the MSVC141 toolset is compatible.
13. In GitHub Actions, how can I restore NuGet packages?
14. Use your solution file after the command nuget restore, such as nuget restore POS.sln.
15. What is the action's Setup MSBuild goal?
16. It sets up the environment to use MSBuild, which is required in order for GitHub Actions to build.NET applications.
17. How can I automatically rename my build artifacts?
18. To rename files according to the build version, use PowerShell commands such as Rename-Item.
19. How come distribution: 'temurin' is included in the Java setup?
20. In order to ensure that the right Java version is installed for your project, this specifies the JDK distribution to use.

Concluding Remarks on Integrating MSVC141

Maintaining the functionality and stability of your Visual Studio 2019 projects requires that the MSVC141 toolset be a part of your GitHub Actions routine. You may avoid typical build issues related to missing files by automating the installation process and updating your.yml scripts. This proactive strategy improves the effectiveness of your CI/CD pipeline and saves time, enabling more streamlined and dependable project builds.