Grapeyard.Labs.Nuke.Launchpad 0.1.1

NUKE Launchpad

Feature extensions and generic target definitions for the NUKE build system for C# and .NET.

Installation

After setting up a NUKE build project as described in the NUKE documentation, install NUKE Launchpad by adding package Grapeyard.Labs.Nuke.Launchpad to it as a NuGet dependency using a NuGet package manager or by adding it manually to its project file:

<ItemGroup>
  <PackageReference Include="Grapeyard.Labs.Nuke.Launchpad" Version="..." />
</ItemGroup>

This will automatically install all packages that are part of NUKE Launchpad and their mandatory transitive dependencies.

If the installation fails with NuGet error NU1202, upgrade the target framework of the NUKE build project to a compatible version first – net7.0 or above – using its project properties or manually via its project file:

<PropertyGroup>
  <TargetFramework>net7.0</TargetFramework>
</ItemGroup>

Usage

NUKE Launchpad contains configurable, reusable and rewritable build components that enable quick and easy realization of lightweight build procedures, by simply implementing the respective parameter and target interfaces:

using System;
using Grapeyard.Labs.Nuke.Launchpad.Parameters;
using Grapeyard.Labs.Nuke.Launchpad.Targets.Clean;
using Grapeyard.Labs.Nuke.Launchpad.Targets.Compile;
using Grapeyard.Labs.Nuke.Launchpad.Targets.Pack;
using Grapeyard.Labs.Nuke.Launchpad.Targets.Restore;
using Grapeyard.Labs.Nuke.Launchpad.Targets.Test;
using Nuke.Common;
using Nuke.Common.Git;

using static Grapeyard.Labs.Nuke.Launchpad.Common.BuildConfiguration;

/// <summary>
/// Entry point of the NUKE build project.
/// </summary>
public class Build
    : NukeBuild,
    IHasGitRepository,   // Parameter interface
    ICleanForDotNet,     // Target interfaces
    IRestoreWithDotNet,
    ICompileWithDotNet,
    IUnitTestWithDotNet,
    IPackWithDotNet
{
    /// <inheritdoc/>
    public string DefaultBuildConfiguration => Git.IsOnMainOrMasterBranch() ? Release : Debug;

    /// <summary>
    /// A representation of the local Git repository.
    /// </summary>
    /// <seealso cref="IHasGitRepository.GitRepository"/>
    private GitRepository Git => ((IHasGitRepository) this).GitRepository;

    /// <summary>
    /// Invokes the build execution and defines any number of default build targets.
    /// </summary>
    public static int Main()
    {
        return Execute<Build>(x => ((ITest) x).Test, x => ((IPack) x).Pack);
    }
}

Use the help command of NUKE afterwards to regenerate the build project and inspect all available build parameters and build targets:

nuke --help

The parameter and target interfaces of NUKE Launchpad are well documented and should be self-explanatory. Always check their documentation before implementing them to be aware of any quirks and configuration options.