Create MSI installer on release

Author: hannes-steffenhagen-diffblue

.github/workflows/pull-request-checks.yaml

@@ -170,6 +170,40 @@ jobs:
           MERGE_BRANCH: ${{ github.ref }}
         run: ./.github/workflows/pull-request-check-cpplint.sh
 
+  # I just added this to check if my stuff is working on github actions
+  windows-msi-package:
+    runs-on: windows-2019
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Fetch dependencies
+        run: |
+          choco install winflexbison3
+      - uses: microsoft/[email protected]
+      - name: Configure with cmake
+        run: |
+          New-Item -ItemType Directory -Path build
+          Set-Location build
+          cmake ..
+      - name: Build Release
+        run: |
+          Set-Location build
+          cmake --build . --config Release
+      - name: Create packages
+        id: create_packages
+        # We need to get the path to cpack because fascinatingly,
+        # chocolatey also includes a command called "cpack" which takes precedence
+        run: |
+          Set-Location build
+          $cpack = "$(Split-Path -Parent (Get-Command cmake).Source)\cpack.exe"
+          & $cpack . -C Release
+          $msi_name = (Get-ChildItem -name *.msi).Name
+          Write-Output "::set-output name=msi_installer::build/$msi_name"
+          Write-Output "::set-output name=msi_name::$msi_name"
+
   check-string-table:
     runs-on: ubuntu-20.04
     steps:

.github/workflows/release-packages.yaml

@@ -24,7 +24,7 @@ jobs:
           cd build
           ninja
       - name: Run CTest
-        run: cd build; ctest . -V -L CORE -C Release 
+        run: cd build; ctest . -V -L CORE -C Release
       - name: Create packages
         id: create_packages
         run: |
@@ -56,3 +56,44 @@ jobs:
           brew bump-formula-pr --tag "$RELEASE_TAG" --revision "$GITHUB_SHA" cbmc
         env:
           HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.DB_CI_CPROVER_ACCESS_TOKEN }}
+
+  windows-msi-package:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Fetch dependencies
+        run: |
+          choco install winflexbison3
+      - uses: microsoft/[email protected]
+        name: Setup Visual Studio environment
+      - name: Configure with cmake
+        run: |
+          New-Item -ItemType Directory -Path build
+          Set-Location build
+          cmake ..
+      - name: Build Release
+        run: |
+          Set-Location build
+          cmake --build . --config Release
+      - name: Create packages
+        id: create_packages
+        run: |
+          Set-Location build
+          $cpack = "$(Split-Path -Parent (Get-Command cmake).Source)\cpack.exe"
+          & $cpack . -C Release
+          $msi_name = (Get-ChildItem -name *.msi).Name
+          Write-Output "::set-output name=msi_installer::build/$msi_name"
+          Write-Output "::set-output name=msi_name::$msi_name"
+      - name: Get release info
+        id: get_release_info
+        uses: bruceadams/[email protected]
+      - name: Upload binary packages
+        uses: actions/upload-release-asset@v1
+        with:
+          upload_url: ${{ steps.get_release_info.outputs.upload_url }}
+          asset_path: ${{ steps.create_packages.outputs.msi_installer }}
+          asset_name: ${{ steps.create_packages.outputs.msi_name }}
+          asset_content_type: application/x-msi

README.md

@@ -30,6 +30,19 @@ Get the [latest release](https://github.com/diffblue/cbmc/releases)
 Get the current *develop* version: `git clone https://github.com/diffblue/cbmc.git`
 * Develop versions are not recommended for production use.
 
+Installing
+==========
+
+### Windows
+
+For windows you can install cbmc binaries via the .msi's found on the
+[releases](https://github.com/diffblue/cbmc/releases) page.
+
+Note that we depend on the Visual C++ redistributables. You likely
+already have these, if not please download and run vcredist.x64.exe from
+[Microsoft](https://support.microsoft.com/en-gb/help/2977003/the-latest-supported-visual-c-downloads) to install them prior to running
+cbmc.
+
 Report bugs
 ===========
 

cmake/packaging.cmake

@@ -57,10 +57,10 @@ set(CPACK_PACKAGE_INSTALL_DIRECTORY "cbmc")
 if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
   set(CPACK_GENERATOR TGZ DEB)
 elseif(WIN32)
-
-  # On windows we need to make sure to ship the
-  # MSVC redistributable
-  include(InstallRequiredSystemLibraries)
+  # Note: We don't ship VC redistributables with
+  # the windows installer; We assume these are likely
+  # already present on a developer machine, and if not
+  # can easily be installed separately via vcredist.exe
   set(CPACK_GENERATOR ZIP WIX)
 endif()