lore-bkw-automation - Confluence

+ Build steps +
+ Script structure +
+ Script step details +
+ Remaining work / bug list +

Build steps

Building the complete KfW product consists of these steps:

+ Setting up the environment [Done except for subversion, logging] +
+ Fetching sources from repositories [cvs done; subversion being worked on] +
+ Building the sources with nmake [Done] +
+ Setting up the packaging environment [Done] +
+ Building KfW.msi with the packaging nmake [Done] +
+ Building other distribution components [Not done] +
- + .exe installer +
- + KfW source distribution +
- + KfW core binaries +
- + KfW SDK +
- + Microsoft redistributable components +
- + Individual files: release notes, Leash user guide, MSI Deployment Guide. +
+

Script structure

The build is a perl script controlled by command line switches and an XML + configuration file. The config file is required. Settings in the config file + can be overridden by optional command line switches.

The main steps in the script are

+ Setting up the environment +
+ Fetching the sources from repositories +
+ Building the sources +
+ Setting up the packaging environment +
+ Building the msi with the package nmake +
+ Building the rest of the components [tbd] +

The usage message shows the available switches:

C:\Projects\KfW>perl bkw.pl /?
+ Usage: bkw.pl (-f --config) config-file [options] NMAKE-options

Options are case insensitive.

Options:
+ /help /? usage information (what you now see)
+ /srcdir dir   Source directory to use. Should contain
+               + pismere/athena. If cvstag or svntag is null,
+               + the directory should be prepopulated.
+ /cvs?ag tag   \ For whichever of these tags is specified,
+ /svntag url   / a checkout will be done into srcdir
+ /debug        Do debug make instead of + release make
+ /outdir dir   Directory to be created where build results will go
+ /nomake       Skip make step
+ /nopackage    Skip packaging step
+ /clean        Build clean target
+ /verbose      Debug mode - verbose output
+ /vverbose     very verbose output
+ /config path Path to config file
+ /logfile path Where to write output. If omitted, ...
+ Other:
+ NMAKE-options any options you want to pass to NMAKE, which can be:
+ (note: /nologo is always used)
+ [ nmake options follow ]

Additional controls, not available from the command line:

<CVSROOT name=":kserver:cvs.mit.edu:/cvs/pismere" />
+ <SVNURL name="" />
+ <CopyList><Config><DebugArea value="dbg" />
+                   + <ReleaseArea value="rel" />
+                   <AlwaysTag + value="%bldtype%" />
+                   + <DebugTag value="%debug%" />
+                   + <ReleaseTag value="%release%" />
+                   + <Files><Include path="copyfiles.xml" />

The CopyList

The CopyList is used during the Setting Up The Packaging Environment + step. Build results and files from all over the source tree are copied into a + 'staging' area in a structure the packaging script expects. The staging area is + <src>/pismere/staging.

The original copy list on which this is based had duplicate entries for debug + and release build results. This version only names each file once, which could + reduce maintenance.

A copylist entry looks like this:

<File name="comerr32.dll" from="..\target\bin\i386\%bldtype%\" to="\bin\i386" />
+

From paths are relative to <src>\pismere\athena and To paths are + relative to <src>\pismere\staging.

Debug and release build results go into directories containing either 'dbg' or + 'rel.' DebugArea and ReleaseArea describe these strings. If + an entry in the copy list contains the AlwaysTag string ('%bldtype%'), + the debug or release file will be copied, depending on the build type. If the + copy list entry contains DebugTag ('%debug%'), the file will only be + copied if packaging a debug build. Ditto for ReleaseTag.

+ If we are doing a debug build, the above copylist entry will copy <src>\pismere\athena\..\target\bin\i386\dbg\comerr32.dll + to <src>\pismere\staging\bin\i386\comerr32.dll. + There are two other possible attributes in a copylist entry: + + + notrequired + + newname="filename" + + + Most copylist entries are required and the script will die if they aren't + present. To ignore missing files, add notrequired. + To rename the file, set the newname attribute. + Remaining work / bug list + This is a work in progress. What's left: + + + Add subversion for checking out krb5. + + Allow empty cvs/svn tags to refer to the trunk. + + Implement ways to skip full checkouts - doing updates or + skipping the repository step completely. + + Figure out which logging package to use and restore original + build.pl logging functionality. + + Pick an unzip package and add the unzip step for the sample + config. Eliminate manual step. + + Produce the remainder of the distribution components. [Listed + above.] + + + Bugs: + + + Propogate leash removal through wix scripts. + + Eliminate need for redundant /debug debug. + + +

+