Skip to content

Windows Build Process

Rian Quinn edited this page Mar 11, 2015 · 36 revisions

This page describes how the Windows build process operates and to run a build you must do so on a Windows Build machine. If you have not yet set one of these up, see [Windows Build Machine](Windows Build Machine) for details.

Setup Build Environment

Install Windows on whatever machine / VM you plan to work in. I think that most people end up using Window 7 32bit or 64bit. Once you have Windows installed, make sure that everything is up-to-date (control panel->system and security->check for updates).

You should now have a barebones, Windows environment. You will need to install the following to get things up and running:

  • WDK 7.1
  • Git
  • DbgView (optional)

WDK 7.1

http://www.microsoft.com/en-us/download/details.aspx?id=11800

Once you download the WDK, you will be given an ISO. If your using a VM, you should be able to mount the ISO as a CDROM, in which case you will be able to install. If your on real hardware, you will either need to burn the iso and then install, or download an application that will let you mount an ISO as a CDROM (there are free versions out there).

Once you have access to the ISO, you will need to run "KitSetup.exe" (or you can just double click the cd-rom in Windows Explorer). Note that this needs to be run as "admin". You will be presented with a set of options (things to install). The useful ones are:

  • Full Development Environment
  • Debugging Tools for Windows

Once you have checked the above, hit ok, and following the rest of the install using the defaults. Note that depending on how barebones your install is, you might have to reboot a couple of times and go through some other packages (like .NET). Just keep hitting next / reboot until you are presented with a dialog that says the install is "finished".

Git

http://git-scm.com/download/win

Once you have downloaded the latest version of Git for Windows, start the install process. Use all of the defaults until you get to a screen that asks for "Adjusting your PATH environment". When you get to this, choose the second option "Use Git from the Windows Command Prompt".

Getting Started

Having set up a build machine, everything is ready for you to perform a build. Within the git repository "openxt.git" is everything you need to compile all of the Windows components and package them. To get this process started check out openxt.git to any location on the build machine and navigate into the "windows" folder:

mkdir C:\Somewhere
c:
cd \Somewhere
git clone https://github.com/OpenXT/openxt.git

NOTE: DO NOT CLONE INTO A PATH CONTAINING SPACES BECAUSE THE BUILD WILL FAIL DUE TO XC-WINDOWS' RELIANCE ON THE WINDDK.

NOTE: START A CYGWIN CONSOLE AT LEAST ONCE BEFORE PROCEEDING. THE FIRST TIME IT IS STARTED IT DOES SOME FURTHER CONFIGURATION THAT MAKES VARIOUS CYGWIN UTILITIES AVAILABLE WHEN USING A COMMAND PROMPT.

Contents of openxt/windows

Within this directory is everything that is required to drive the windows build:

  • winbuild-all.ps1 - Actually does and manages the build
  • winbuild-prepare.ps1 - prepares the system for a build
  • configs directory - stores config files to dictate how the build operates
  • BuildSupport directory - Additional scripts to be used as sub-steps of/support for the build
    And additional bits:
  • mkbuildmachine directory - The scripts you used to [create your build machine](Windows Build Machine)

Running a build

To run a complete build, the script winbuild-prepare.ps1 must be used first to generate the config.xml file, followed by the winbuild-all.ps1 script. For example:

c:
cd \Somewhere\openxt\windows
powershell .\winbuild-prepare.ps1 config=sample-config.xml build=123456 branch=master certname=developer developer=true
powershell .\winbuild-all.ps1

Where developer is the name of the signing certificate.

Verification of your build

In Windows Explorer right click and select properties on C:\Somewhere\openxt\windows\msi-installer\iso\windows\setup.exe. There should be a tab called Digital Signatures and you should see the name of your certificate ("developer" in our example).

Installing your development certificates

When using developement signing certificates and keys as outlined on the [Windows Build Machine](Windows Build Machine) page, the certificates need to be imported to the certificate store on the target system. For 23b systems this is optional but it is required on 64b ones. On the target machine do the following:

Open a command prompt with right click and "Run as Administrator". Run the following and reboot:

bcdedit /set testsigning on

Get a copy of your test signing certificate file. This will be found in the location where you ran makecert.bat (developer.cer in our examples). Open a command prompt with right click and "Run as Administrator". Run the following and reboot:

certutil -addstore -f "Root" developer.cer
certutil -addstore -f "TrustedPublisher" developer.cer

Not you can install the test signed tools package.

Installing your tools on an OpenXT VM

The output from the build should end up in a file like this:

C:\Somewhere\openxt\windows\output\xctools-iso.zip

The easiest way to test your Windows build is to copy the zip file on to an OpenXT Windows VM, expand it and run the windows\setup.exe file which should install files.

NOTE: that unattendedInstall.bat has references to certificates in windows\SupportFiles which would need to be updated to install the certificate you used to build.

Windows ISO

An enhancement to the Windows build is being added to cause the Windows build scripts to also generate an ISO. The ISO file ends up in $Outdir\xc-wintools.iso with the rest of the Windows build output. It of course only contains the Windows specific guest tools.

The change requires the mkisofs Cygwin package to be installed. If you use the scripts to setup a build machine after the feature is in, you will get this automatically. On older build machines the ISO step will be skipped so as not to break existing kit.

If you want to manually add mkisofs to your existing build machine, you need to rerun the Cygwin installer which you can find here:

https://www.cygwin.com/setup-x86.exe

Run it, take the default options until you get to the package selector. The installer will detect what you already have so you can just check new packages and install them. The mkisofs is found in several places including under the "Utils" list.