Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.77 KB

Build and deploy with AdvancedInstaller.md

File metadata and controls

57 lines (43 loc) · 2.77 KB
Raw

Build pre-requisites

  • AdvancedInstaller (license required)
    • Once installed run Advanced Installer
    • Since some dialogs are shared between all installers, you might need to tell AdvancedInstaller to look locally for these files. Go to Settings -> Repository Manager -> top level Settings -> Change repository path. Set it to /installers
    • Apply and close Advanced Installer
  • WiX Toolset (https://wixtoolset.org/releases/)
  • Visual Studio (e.g. 2019 community edition)

To build installers:

  • Open OptikeyDeployment.sln in VS
  • Ensure \src\JuliusSweetland.OptiKey.Core\Properties\AssemblyInfo.cs has the correct version number
  • Commit and push all changes to GitHub (so that the release tag lines up with the correct version of the codebase)
  • Ensure \src\JuliusSweetland.OptiKey.Core\app.manifest has uiAccess="true"
  • Build entire solution in Release
  • Manually sign all required (or all 4) exe files
  • Open all four AIP projects e.g. /installers/OptikeyMouse.aip
  • Manually set the installer version to match the AssemblyInfo.cs version number
  • Build all in AdvancedInstaller
  • Setup files will be built in /installers/SetupFiles/
  • Manually sign all installer exe files

Ignoring generate code changes

When you build the deployment solution you'll get some changes in git that you'll want to ignore with: git update-index --skip-worktree src/JuliusSweetland.OptiKey.InstallerActions/InstallerStrings.cs

Tests

There are a few tests in the Deployment solution. It would be worth hooking them up to CI at some point. I took them out of the main unit test project, since I wanted to keep all the extra deployment-related projects in the separate solution.

You can use python to automate this process

Requirements

  • Use python3
  • Add AdvancedInstaller.com to your path (it will be somewhere like /c/Program Files (x86)/Caphyon/Advanced Installer 19.2/bin/x86/AdvancedInstaller.com)
  1. Run python update_version.py --revision:

This will:

  • update the AssemblyVersion in the AssemblyInfo.cs for all the projects (Core + four apps)
  • update the version in all the AdvancedInstaller projects (four apps)
  • commit the changes

It will not ensure all the versions are the same in lock-step, but if they are currently matched then they will be incremented together.

  1. Run python release.py

This will:

  • Delete all build directories (with a user prompt)
  • Change uiAccess = true in the app.manifest
  • Clean and Rebuild OptikeyDeployment.sln
  • Build all the installers via AdvancedInstaller
    • As part of this process, the EXE files will be signed before the installer is built, and the installer output will be signed too.
    • You will be prompted for signing authentication at the appropriate time
  • Clean all build artefacts