Table of Contents

Interface IBuildDefinition

Namespace
Invex.Atom.Build.Definition
Assembly
Invex.Atom.Build.dll

Defines the core structure and components of an Atom build process.

public interface IBuildDefinition : IBuildAccessor
Inherited Members

Remarks

This interface outlines the fundamental elements of a build, including its targets, parameters, workflow configurations, and global options. Implementations, typically derived from BuildDefinition, serve as the central point for Atom to understand and execute a build.

Properties

Options

Gets the build options applied globally to this build definition. Override to supply a custom list of IBuildOption instances.

IReadOnlyList<IBuildOption> Options { get; }

Property Value

IReadOnlyList<IBuildOption>

ParamDefinitions

Gets the collection of parameter definitions for the build.

IReadOnlyDictionary<string, ParamDefinition> ParamDefinitions { get; }

Property Value

IReadOnlyDictionary<string, ParamDefinition>

Remarks

Parameters allow for external input to customize the build process. This collection is populated by source generation based on properties marked with ParamDefinitionAttribute or SecretDefinitionAttribute.

TargetDefinitions

Gets the collection of target definitions for the build.

IReadOnlyDictionary<string, Target> TargetDefinitions { get; }

Property Value

IReadOnlyDictionary<string, Target>

Remarks

Targets represent individual units of work. This collection is populated by source generation based on Target properties in interfaces that inherit IBuildAccessor

Methods

AccessParam(string)

Retrieves the value of a build parameter by its name.

object? AccessParam(string paramName)

Parameters

paramName string

The name of the parameter to access.

Returns

object

The value of the specified parameter, or null if not defined or has no value.