Skip to content

About

Shared components for the Fallout build system

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

fallout-components | continuous release

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.

Contributing

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 install

Usage

To 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.

Build

This project uses the Fallout build tool (naturally). Fallout builds can be invoked in the following ways:

Fallout global tool

The preferred way to invoke Fallout builds is with the global tool. To install it, run the following command:

dotnet tool install Fallout.GlobalTool --global

The tool installs as the command fallout. Verify your installation by listing the available targets:

fallout --help

Build targets can now be run like so:

fallout compile
fallout test
fallout verify-format
# etc.

ℹ On Linux, you may need to add $HOME/.dotnet/tools to your PATH before the fallout command 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.

Scripts

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' target

Console app

Fallout 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.

About

Shared components for the Fallout build system

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages