Grapeyard.Labs.Nuke.Launchpad
1.0.0
dotnet add package Grapeyard.Labs.Nuke.Launchpad --version 1.0.0
NuGet\Install-Package Grapeyard.Labs.Nuke.Launchpad -Version 1.0.0
<PackageReference Include="Grapeyard.Labs.Nuke.Launchpad" Version="1.0.0" />
paket add Grapeyard.Labs.Nuke.Launchpad --version 1.0.0
#r "nuget: Grapeyard.Labs.Nuke.Launchpad, 1.0.0"
// Install Grapeyard.Labs.Nuke.Launchpad as a Cake Addin
#addin nuget:?package=Grapeyard.Labs.Nuke.Launchpad&version=1.0.0
// Install Grapeyard.Labs.Nuke.Launchpad as a Cake Tool
#tool nuget:?package=Grapeyard.Labs.Nuke.Launchpad&version=1.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="1.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, upgrade 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 | Versions 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. |
-
net8.0
- Grapeyard.Labs.Nuke.Launchpad.Common (>= 1.0.0)
- Grapeyard.Labs.Nuke.Launchpad.Parameters (>= 1.0.0)
- Grapeyard.Labs.Nuke.Launchpad.Targets (>= 1.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
• Added string constants for logged test results in the Visual Studio Test Format (file extension .trx) to the Constants class.
• Added a private constructor to the VersionType class as the default constructor to prevent it from being instantiated.
• Added the following methods to the IEnumerableExtensions class:
◦ Method RemoveInstancesNextToTargets that removes elements from an enumerable that are instances, as defined by one predicate, and appear next to targets, as defined by another predicate.
◦ Method EvaluateEagerly that eagerly evaluates enumerables to prevent deferred execution.
• Updated target framework version from .NET 7 to .NET 8.
• Updated target language version from C# 11 to C# 12.
• Changed the collection types of the following properties and return values to prevent unexpected side effects due to deferred execution and/or to better conform to the principle "Return the most specific type, accept the most generic type":
◦ Return value types of all methods of the BadgeProvider, BadgeProviderExtensions, BadgenTasks and ShieldsTasks classes that update static badges in an input enumerable from IEnumerable<string> to string[].
◦ Return value type of method ExtractReleaseNotes of the KeepAChangelogFormatTasks class from List<string> to IReadOnlyList<string>.
◦ Return value type of overloaded method FinalizeChangelog of the KeepAChangelogFormatTasks class from List<string> to string[].
◦ Return value type of method UpdateVersionOfNuGetPackageReferences of the DocumentingTasks class from IEnumerable<string> to string[].
◦ Return value type of method UpdateLastPublicationYearOfCopyrightNotices of the LicensingTasks class from IEnumerable<string> to string[].
◦ Return value types of all methods of the ProjectExtensions and SolutionExtensions classes that retrieve the names or the package identifiers of projects from IEnumerable<string> to IReadOnlyCollection<string>.
◦ Property types of properties PreRelease and BuildMetadata of the SemanticVersion class from ReadOnlyCollection<string> to IReadOnlyList<string>.
◦ Return value type of method GetBuildProjectOutputDirectories of the IClean target base interface from AbsolutePath[] to IReadOnlyCollection<AbsolutePath>.
• Added an optional parameter to method ExtractReleaseNotes of the KeepAChangelogFormatTasks class, allowing to specify whether change type groups, if any, should be merged in the extracted release notes.
• Added a trailing slash to the default values of all build parameters that represent directory paths to more clearly distinguish them from file paths.
• Changed the type of overridable expression trees of Boolean requirements and conditions (properties ExecutionRequirements and InclusionConditions) to IEnumerable<T> for all build targets to make them more versatile.
• Fixed a bug in method UpdateVersionOfNuGetPackageReferences of the DocumentingTasks class that could cause mismatched NuGet package references to be updated for package identifiers that contained regular expression metacharacters.
• Fixed a bug in the following methods that could cause an exception to be thrown if the enumerable passed to them was resized during their execution:
◦ Methods GetToplevelGitDirectory and IsGitStatusShortClean of the ExtendedGitTasks class.
◦ Methods ConvertAll, JoinElementsToString and OrderAndDistinctBy of the IEnumerableExtensions class.
Full changelog at https://gitlab.com/grapeyard-labs/libs/nuke-launchpad/-/blob/1.0.0/CHANGELOG.md