An opinionated task and build automation framework#
License
—
Deps
3
Install Size
—
Vulns
✓ 0
Published
Jan 23, 2026
Get Started
$ dotnet add package DecSm.Atom.Module.Dotnet
Readme
Atom
Atom is an opinionated task and build automation framework, written in C#.
Inspired by the likes of NUKE, Atom aims to provide a flexible, extensible framework for defining
and executing build tasks. It leverages .NET and provides a comprehensive set of features for automating your
development workflow with automatic CI/CD pipeline generation e.g. for GitHub Actions and Azure DevOps.
✨ Features
🎯 Type-Safe Build Definitions: Define build targets using strongly-typed C# interfaces and classes
🔄 Automatic CI/CD Generation: Generate GitHub Actions and Azure DevOps pipelines from your build definitions
📦 Artifact Management: Built-in support for artifact storage and retrieval with CI/CD host or a custom provider
🔐 Secret Management: Secure secret handling with .NET secrets or custom providers
🧩 Modular Architecture: Extensible module system for different platforms and tools
⚙️ Parameter Management: Flexible parameter system with validation and optional interactive prompting
📊 Reporting: Comprehensive build reporting with CI/CD platform integration
🔨 .NET Tooling: Built-in support for .NET operations (build, test, pack, publish)
📝 Source Generation: Automatic code generation for build definitions
🚀 Quick Start
1. Create a New Build Project
Create a new console application and add the Atom package:
dotnet new console -n MyBuild
cd MyBuild
dotnet add package DecSm.Atom
2. Define Your Build
Create a Build.cs file:
using DecSm.Atom.Build.Definition;
using DecSm.Atom.Hosting;
namespace MyBuild;
[BuildDefinition]
[GenerateEntryPoint]
internal partial class Build : BuildDefinition
{
private Target HelloWorld =>
t => t
.DescribedAs("Prints a hello world message")
.Executes(() => Logger.LogInformation("Hello, World!"));
}
Targets can also be async:
private Target HelloWorldAsync =>
t => t
.DescribedAs("Prints a hello world message asynchronously")
.Executes(async () =>
{
await Task.Delay(1000); // Simulate async work
Logger.LogInformation("Hello, World!");
});
private Target HelloWorldAsyncWithCancel =>
t => t
.DescribedAs("Prints a hello world message asynchronously")
.Executes(async cancellationToken =>
{
await Task.Delay(1000, cancellationToken); // Simulate async work with cancellation
Logger.LogInformation("Hello, World!");
});
3. Run Your Build
dotnet run -- HelloWorld
📚 Documentation
Basic Concepts
Build Definitions
Build definitions are classes that inherit from BuildDefinition and define targets (build steps) as properties:
[BuildDefinition]
internal partial class Build : BuildDefinition
{
private Target Compile => t => t
.DescribedAs("Compiles the project")
.Executes(() =>
{
// Your build logic here
});
}
Parameters
Define and use parameters in your builds:
[ParamDefinition("my-name", "Name to greet")]
private string? MyName => GetParam(() => MyName);
private Target Hello => t => t
.RequiresParam(nameof(MyName))
.Executes(() =>
{
Logger.LogInformation("Hello, {Name}!", MyName);
});
Target Dependencies
Define dependencies between targets:
private Target Test => t => t
.DependsOn(Compile)
.Executes(() =>
{
// Run tests after compilation
});
Target Interfaces
You can also define targets using interfaces for better organization:
using DecSm.Atom.Build.Definition;
[BuildDefinition]
internal partial class Build : BuildDefinition, ICompile, ITest;
public interface ICompile
{
Target Compile => t => t
.DescribedAs("Compiles the project")
.Executes(() =>
{
// Your build logic here
});
}
public interface ITest
{
Target Test => t => t
.DependsOn(Compile)
.Executes(() =>
{
// Run tests after compilation
});
}
Access Build Services
You can access various build services like logging, parameters, and secrets:
public interface ICompile : IBuildAccessor
{
Target Compile => t => t
.DescribedAs("Compiles the project")
.Executes(() =>
{
Logger.LogInformation("Compiling project...");
FileSystem.File.Create("output.txt");
Services.Get<IService>().DoSomething();
});
}
CI/CD Integration
Atom can automatically generate CI/CD pipelines for your builds:
GitHub Actions
Install the required modules for your CI/CD platform (GitHub Actions, Azure DevOps, etc.):
