Grapeyard.Labs.Nuke.Launchpad 1.1.0

dotnet add package Grapeyard.Labs.Nuke.Launchpad --version 1.1.0                
NuGet\Install-Package Grapeyard.Labs.Nuke.Launchpad -Version 1.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Grapeyard.Labs.Nuke.Launchpad" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Grapeyard.Labs.Nuke.Launchpad --version 1.1.0                
#r "nuget: Grapeyard.Labs.Nuke.Launchpad, 1.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Grapeyard.Labs.Nuke.Launchpad as a Cake Addin
#addin nuget:?package=Grapeyard.Labs.Nuke.Launchpad&version=1.1.0

// Install Grapeyard.Labs.Nuke.Launchpad as a Cake Tool
#tool nuget:?package=Grapeyard.Labs.Nuke.Launchpad&version=1.1.0                

NUKE Launchpad

Quickstart and extension library for the build automation tool NUKE for C# and .NET.

It contains common feature extensions as well as predefined build parameters and build targets in the form of configurable build component interfaces, that enable quick and easy realization of lightweight build processes.

Installation

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

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

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

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

<TargetFramework>net8.0</TargetFramework>

Usage

For the fundamentals of working with NUKE, read its documentation first.

When utilizing NUKE, the build process of a solution is defined using a NUKE build project. The project contains a central build class, usually located in a file Build.cs, that inherits the NukeBuild class and defines build parameters and build targets, which are individual steps of the build process. Both build parameters and build targets may either be defined directly in the central build class or in the form of build component interfaces to be implemented by it.

NUKE Launchpad contains predefined build parameters and build targets in the form of configurable build component interfaces, that enable quick and easy realization of lightweight build processes, by simply making the central build class implement them:

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,
    IUsesGitRepository,  // Optional 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="IUsesGitRepository.GitRepository"/>
    private GitRepository Git => ((IUsesGitRepository) this).GitRepository;

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

After modifying the central build class, the NUKE build project can be regenerated using the help command of NUKE, which also retrieves a list of available build parameters and build targets:

nuke --help

The parameter and target interfaces of NUKE Launchpad are documented extensively and should be self-explanatory. Check their code documentation before implementing them to be aware of potential quirks and configuration options.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 95 8/29/2024
1.0.0 115 5/17/2024
0.3.0 129 3/14/2024
0.2.0 188 1/8/2024
0.1.1 117 9/8/2023
0.1.0 123 9/6/2023

Added

• Integrated NuGet audit to automatically check for security vulnerabilites in NuGet dependencies during the build process.
• Added string constants for the default year separators used in copyright notices to the Constants class.
• Added the following methods to the AbsolutePathExtensions class:
   ◦ Method ReadWriteAllLinesAtomically that reads all lines of an existing file, modifies them via a custom delegate function and then writes them back to the file atomically, i.e. by first writing them to a temporary buffer file.
   ◦ Method WriteAllLinesAtomically that writes all lines to an existing file atomically, i.e. by first writing them to a temporary buffer file.
• Added method UpdateLastPublicationYearOfCopyrightNoticesUsingSingleYearSpans to the LicensingTasks class, that updates the last publication years of copyright notices found in an input enumerable, combining multiple publication years, if any, into a single year span for each notice in the process.
• Added the following configuration properties to the IUpdateCopyrightYearsOfRepositoryLicenseToCurrent target surrogate interface:
   ◦ Property CopyrightYearSeparator that allows specifying the separator used to link first and last publication years of copyright notices.
   ◦ Property LimitToTwoCopyrightYears that allows to limit the update of last publication years of copyright notices to single year spans respectively a maximum of two publication years.

Changed

• Updated dependencies to NuGet package GitVersion.Tool from version 5.12.0 to 6.0.2.
• Added an optional parameter to overloaded method ExtractReleaseNotesForNuGet of the KeepAChangelogFormatTasks class, allowing to specify whether change type groups, if any, should be merged in the extracted release notes.
• Changed the process of method UpdateLastPublicationYearOfCopyrightNotices of the LicensingTasks class to preserve multiple publication years of copyright notices found in an input enumerable, if any, while updating their last publication years. Therefore, it is now compatible with e.g. license terms of the GNU project.
• Changed the default value of build parameter --test-code-dir of the IHasTestCode parameter interface, that specifies the relative path to a test code directory, from test/ to tests/.
• Implemented method ReadWriteAllLinesAtomically of the AbsolutePathExtensions class in all applicable build targets.

Full changelog at https://gitlab.com/grapeyard-labs/libs/nuke-launchpad/-/blob/1.1.0/CHANGELOG.md