Anarchy.Toolkit.Build.Fallout 2.0.0

Suggested Alternatives

Anarchy.Toolkit.Automation.Build

There is a newer version of this package available.
See the version list below for details.
dotnet add package Anarchy.Toolkit.Build.Fallout --version 2.0.0
                    
NuGet\Install-Package Anarchy.Toolkit.Build.Fallout -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="Anarchy.Toolkit.Build.Fallout" Version="2.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Anarchy.Toolkit.Build.Fallout" Version="2.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Anarchy.Toolkit.Build.Fallout" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Anarchy.Toolkit.Build.Fallout --version 2.0.0
                    
#r "nuget: Anarchy.Toolkit.Build.Fallout, 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.
#:package Anarchy.Toolkit.Build.Fallout@2.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Anarchy.Toolkit.Build.Fallout&version=2.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Anarchy.Toolkit.Build.Fallout&version=2.0.0
                    
Install as a Cake Tool

Anarchy.Toolkit.Build.Fallout

Reusable Fallout build components for .NET repositories.

dotnet add build/_build.csproj package Anarchy.Toolkit.Build.Fallout

Implement the components appropriate to your repository on a FalloutBuild class. For example, a package-only build can implement INuGetBuild, ILayeringBuild, IDependencyMapBuild, IDependencyUpgradeBuild and IGitHooksBuild, with an empty Artifacts collection. Use IBoilerplateBuild for scaffolding, or add the AWS, container, CodeDeploy and Slack components as needed. External deployment and publication targets require their respective tools and credentials.

using Anarchy.Toolkit.Build.Fallout.Component;
using Anarchy.Toolkit.Build.Fallout.Core.Entity.Build;
using Anarchy.Toolkit.Build.Fallout.Infrastructure.Extension;
using Fallout.Common;

class Build : FalloutBuild, INuGetBuild, ILayeringBuild, IDependencyMapBuild,
              IDependencyUpgradeBuild, IGitHooksBuild
{
    public IReadOnlyCollection<Artifact> Artifacts => [];
    public static int Main() => Execute<Build>(x => x.As<IDefaultBuild>().Clean);
}

Create .fallout/parameters.json with the solution path, then run dotnet run --project build/_build.csproj -- --help to see targets and parameters. The included scaffolding target writes its solution setting to .fallout/parameters.json; it will not overwrite existing files.

See the Fallout builds guide for component details and package publishing.

Starting from an empty folder

For a guided setup, including APIs, jobs and UIs, install the Anarchy.Toolkit.Build.Cli.Tool global tool and run anarchy-toolkit bootstrap. See the tool README. To set up the build host manually instead:

With the .NET 10 SDK, Bash and Make installed, create a build host first:

mkdir -p build .fallout
dotnet new console --framework net10.0 --name _build --output build
dotnet add build/_build.csproj package Anarchy.Toolkit.Build.Fallout
printf '{}\n' > .fallout/parameters.json

Use the example above in build/Program.cs, adding IBoilerplateBuild to the class. Then generate a starter solution and try the build:

dotnet run --project build/_build.csproj -- SetupBoilerplate --boilerplate-solution-name MyApp
make compile
make check_layering

By default, scaffolding creates a solution containing the build and a starter src/Core project, along with tests/, samples/, docs/, Makefile, scripts and configuration files. Review the supplied .NET SDK and test-runner settings and enable or adapt the optional Make targets for your build components and tools.

Choosing what to install

Use --boilerplate-items for a comma-separated allowlist and --boilerplate-exclude to remove items. Names are case-insensitive; omit the allowlist to select everything.

Item Effect
solution Create the named .sln, add the existing build and selected Core project, and set Solution in .fallout/parameters.json. Requires --boilerplate-solution-name.
core Create src/Core/Core.csproj. Add it to a solution yourself if solution is excluded.
tests, samples, docs Create the directory and its .gitkeep.
Makefile, .gitignore, .editorconfig, global.json, nuget.config Install the corresponding packaged file.
Directory.Build.props Create the SQL resource embedding rule if the file is absent.
scripts Install all scripts; individual paths such as scripts/build.fallout.sh or scripts/bootstrap can also be selected or excluded.

all selects every item and none selects nothing. Unknown names fail before any files are written. When selecting individual scripts, include their helpers: the launcher needs scripts/shared/colors.env, scripts/console/subtitle.sh and, unless environment reloading is disabled, scripts/bootstrap/shell-profile-path.sh.

Existing .gitignore and .editorconfig files are untouched unless --append-existing (or --apend-existing) is supplied; packaged content is then appended at most once. Review the result because later rules can change earlier ones. Existing global.json, nuget.config and Directory.Build.props are always preserved. The target refuses to overwrite a solution, selected script, Makefile, starter project, .gitkeep or existing Solution parameter. If an operation fails partway through, inspect the output before retrying.

Releases

2.0.0

  • Breaking: layering, dependency map, release version and notes, Git hook, lint staging and local process tasks, their entities and the connection-string helpers moved to Anarchy.Toolkit.Build.Cli (namespaces Anarchy.Toolkit.Build.Cli.Core.* and .Infrastructure.Helper). Targets are unchanged; update using directives that referenced them directly.
  • ILayeringBuild gains the LayeringLayers and LayeringApplicationFolders parameters, so layers and application folders (e.g. src/Api=Web) can be configured in .fallout/parameters.json.
  • The packaged Makefile and scripts now come from Anarchy.Toolkit.Build.Cli.

1.0.2

  • chore(deps): update AWS SDK packages
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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.

Initial release.