Shared components for the Fallout build system.
For more information about these components, see the docs.
To read more about shared components in general, see the official Fallout docs.
This library is published to NuGet.
This repository uses Husky.Net for pre-push hooks. After cloning the repo, set up husky by running the following commands:
dotnet tool restore
dotnet husky installTo use the shared components in your build, install the NuGet package:
dotnet package add Hexagrams.Fallout.Components --project .\build\MyFalloutBuild.csprojℹ In your build project, you'll want to keep or add an explicit package reference to
Fallout.Common. This will ensure you keep the project organization provided by the Fallout MSBuild targets:dotnet package add Fallout.Common --project .\build\MyFalloutBuild.csproj
See the samples for examples of how to use these components in your build projects.
This project uses the Fallout build tool (naturally). Fallout builds can be invoked in the following ways:
The preferred way to invoke Fallout builds is with the global tool. To install it, run the following command:
dotnet tool install Fallout.GlobalTool --globalThe tool installs as the command fallout. Verify your installation by listing
the available targets:
fallout --helpBuild targets can now be run like so:
fallout compile
fallout test
fallout verify-format
# etc.ℹ On Linux, you may need to add
$HOME/.dotnet/toolsto yourPATHbefore thefalloutcommand resolves.
A global install is optional. This repo also pins the tool in
.config/dotnet-tools.json, so the local copy works just as well:
dotnet tool restore
dotnet fallout testℹ For added flavour, enable tab-completion for the global tool in your shell. See the official docs for instructions here.
Fallout generates PowerShell, cmd, and bash scripts that invoke builds and build
targets. To select a build target, specify it either as an argument or with the
--target switch. For example:
./build.ps1 # Run the default build
./build.ps1 test # Run the 'test' target
./build.ps1 --target test # Run the 'test' targetFallout builds are pure C# console apps. So, to run a build you can run the
_build project from your IDE, just as you would any other executable.