Grapeyard.Labs.Nuke.Launchpad 2.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Grapeyard.Labs.Nuke.Launchpad --version 2.0.0                

                    
                

            
NuGet\Install-Package Grapeyard.Labs.Nuke.Launchpad -Version 2.0.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="2.0.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 2.0.0                

                    
                

            
#r "nuget: Grapeyard.Labs.Nuke.Launchpad, 2.0.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=2.0.0

// Install Grapeyard.Labs.Nuke.Launchpad as a Cake Tool
#tool nuget:?package=Grapeyard.Labs.Nuke.Launchpad&version=2.0.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="2.0.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
2.0.2 78 11/6/2024
2.0.1 80 11/5/2024
2.0.0 75 10/30/2024
1.1.0 101 8/29/2024
1.0.0 117 5/17/2024
0.3.0 137 3/14/2024
0.2.0 192 1/8/2024
0.1.1 120 9/8/2023
0.1.0 128 9/6/2023

Added

• Integrated the central package management (CPM) feature of NuGet to manage dependency versions from a central file.
• Added an optional Boolean logging parameter to the following methods, allowing to enable or disable logging of the publishing process:
   ◦ Method PublishFileToDirectory of the ExtendedFileSystemTasks class.
   ◦ Method PublishPackagesToLocalPackageRepositories of the IPublishToLocalPackageRepositories target base interface.
• Added class ConditionalLog that contains wrapper methods which forward calls to the Serilog library based on runtime conditions.
• Added configuration property ExtensiveLogging to the following target interfaces:
   ◦ Target surrogate interface IFinalizeChangelogWithKeepAChangelogFormat. The property allows extensive logging to be enabled for read and write access to the changelog file during a target run.
   ◦ Target surrogate interface IPublishToLocalPackageRepositoriesForDotNet. The property allows extensive logging to be enabled for the copying of NuGet packages to local package repositories during a target run.
   ◦ Target surrogate interface IUpdateCopyrightYearsOfRepositoryLicenseToCurrent. The property allows extensive logging to be enabled for read and write access to the license file of the repository during a target run.

Changed

• Breaking: Generalized the names of the optional Boolean logging parameters of the following methods, made most of the parameters relevant to all local logging statements instead of just some and changed their default values to false to make them less intrusive:
   ◦ Method UpdateStaticBadges of the BadgeProvider class. Renamed the parameter from logBadgeUpdate to logUpdate.
   ◦ Methods UpdateStaticBuildStatusBadges, UpdateStaticTestResultsBadges and UpdateStaticVersionBadges of the BadgeProviderExtensions class. Renamed the parameters from logBadgeProvider to logUpdate.
   ◦ Method UpdateVersionOfNuGetPackageReferences of the DocumentingTasks class. Renamed the parameter from logVersionUpdate to logUpdate.
   ◦ Methods WriteAllLinesAtomically and ReadWriteAllLinesAtomically of the AbsolutePathExtensions class. Renamed the parameters from logTempFileCreation to logWriting and logReadingWriting.
   ◦ Methods CreateTempFile, DeleteFile and DeleteDirectory and overloaded methods DeleteFiles and DeleteDirectories of the ExtendedFileSystemTasks class. Renamed the parameters from logFileCreation, logFileDeletion and logDirectoryDeletion to logCreation and logDeletion.
   ◦ Overloaded method CreateTestReportFromLogFilesInDirectory of the VisualStudioTestFormatTasks class. Renamed the parameter from logTestLogFiles to logCreation.
   ◦ Method UpdateStaticBadgesForBadgeProviders of the IUpdateStaticBadges target bundle interface. Renamed the parameter from logVerbosely to logUpdate.
   ◦ Method DeleteSuperfluousThirdPartyLicenses of the IUpdateThirdPartyLicenses target bundle interface. Renamed the parameter from logFileDeletion to logDeletion.
• Breaking: Renamed parameter interface IUsesVerboseLogging to IUsesExtensiveLogging and its build parameter --verbose-logging to --extensive-logging to better distinguish it from the default build parameter --verbosity of NUKE. Changed the build parameter's default value to true.
• Breaking: Renamed the configuration properties concerning logging of the following target interfaces to ExtensiveLogging, thereby reflecting the name change of parameter interface IUsesVerboseLogging to IUsesExtensiveLogging, and changed their default values to true to activate extensive logging by default:
   ◦ Properties VerboseLogging of the ICleanForDotNet, IUpdateStaticBadgesInMainReadmeForBadgeProviders, IUpdateDocumentedNuGetPackageReferencesOfProjectsToNewest and IUpdateThirdPartyLicensesFromWebLinks target surrogate interfaces.
   ◦ Properties VerboseReportLogging of the IIntegrationTestWithDotNet and IUnitTestWithDotNet target surrogate interfaces.
• Updated dependencies to NuGet package Nuke.Common from version 8.0.0 to 8.1.2.
• Updated dependencies to NuGet package GitVersion.Tool from version 6.0.2 to 6.0.3.
• Modified overloaded method ExtractReleaseNotesForNuGet of the KeepAChangelogFormatTasks class to remove the Markdown emphases for bold and bold-italic text using two and three asterisks from logged changes.
• Modified build parameter --local-package-repository-dirs of the IHasLocalPackageRepositories parameter interface to accept both relative and absolute paths as input values.

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