Build Scripts in Projects

NOTE Consider to name build scripts like <some-project-name>.build.ps1, not .build.ps1. The latter is historically used in some mentioned projects and was fine for Windows. But PowerShell 6.0 is going to be cross-platform. On *nix systems .build.ps1 files are hidden from ls by default.

---

Invoke-Build, Helps (PowerShell scripts)

• Invoke-Build/.build.ps1
• Helps/.build.ps1

These scripts are for pure PowerShell script projects. The following tasks are automated:

• Clean the project directory
• Run tests and compare results with expected
• Build the help file (PowerShell MAML format)
• Convert markdown files to HTML for packages
• Create packages

---

SplitPipeline, Mdbc (C#, PowerShell modules)

• SplitPipeline/.build.ps1
• Mdbc/.build.ps1

These scripts are examples of mixed build tools: Invoke-Build and MSBuild work together and call each other. See how the configuration parameter is passed in both directions.

The task Build calls MSBuild in order to build the C# project:

    exec { MSBuild Src\Mdbc.csproj /t:Build /p:Configuration=$Configuration }

The task PostBuild is called by MSBuild as the post-build event, it copies the just built module and its satellite files to one of the PowerShell module directories, so that it is ready to use/debug after the build. The post-build command line is:

PowerShell.exe -NoProfile Invoke-Build PostBuild $(ProjectDir)\..\.build.ps1 -Configuration $(ConfigurationName)

Or even simpler with ib.cmd which also bypasses execution policy restrictions:

ib PostBuild $(ProjectDir)\..\.build.ps1 -Configuration $(ConfigurationName)

Other tasks are typical: clean, test, build and test help, create packages. Both projects use Invoke-Build for testing, each test is represented by a task in a test build script.

---

OneBuild uses Invoke-Build

• OneBuild.build.ps1

OneBuild is a modular set of convention based .NET solution build scripts written in PowerShell, relying on Invoke-Build for task automation. See OneBuild for more details.

---

PowerShellTraps does not build

• PowerShellTraps/.build.ps1

This project is a collection of PowerShell issues described by markdown files, demo scripts, and test scripts. There is nothing to build here. The build script is for testing, generating the index, and other routine tasks.

---

FarNet family (C++, C#, PowerShell)

This project maintains the complex build system where Invoke-Build and MSBuild work together in the hierarchy of projects with Invoke-Build scripts, MSBuild scripts (C++ and C# projects), and Visual Studio solutions.

Parent project scripts dispatch common tasks like Build, Install, Clean to child scripts, some of them dispatch these tasks further to their children.

One of the scripts in this hierarchy is a build task library which is imported by other build scripts. Another point of interest is use of property. It gets parent script values in child scripts, parents do not have to to specify them explicitly on task dispatching.

• .build.ps1 - root build script dispatches tasks to 2 child projects
  • PowerShellFar.build.ps1
  • FarNet.build.ps1 - dispatches tasks to 11 child projects
    • FarNet/.build.ps1
    • FarNetMan/.build.ps1
    • FarNet.tasks.ps1 - task library imported by build scripts
      • FarNet.Settings/.build.ps1 - trivial with all tasks imported
      • Other projects with trivial build scripts ...

---

red-gate build scripts

Some red-gate projects use Invoke-Build scripts:

• build-script-template/build.ps1
• XmlDoc2CmdletDoc/build.ps1
• RedGate.ThirdParty.NodeJs/build.ps1

---

PSReadLine (PowerShell module)

• PSReadline.build.ps1

---

PowerShellEditorServices (common functionality across multiple editors)

• PowerShellEditorServices.build.ps1