Table of Contents

API Reference

This reference is generated from the XML documentation of every public type in the Atom packages; the tables below list the main entry points per package, and the sidebar lists everything else.

Invex.Atom.Build

Type Kind Description
IBuildDefinition Interface The core structure of an Atom build; extend it with an interface build definition.
BuildDefinition Class Abstract base class for partial-class build definitions.
BuildDefinitionAttribute Attribute Marks a build definition and triggers source generation of its targets and parameters.
GenerateEntryPointAttribute Attribute Generates the application's Main method.
Target Delegate Applies configuration to a TargetDefinition; the type of every target property.
TargetDefinition Class Fluent definition of a target's tasks, dependencies, parameters, artifacts, and variables.
IBuildAccessor Interface Access to the logger, file system, process runner, services, and parameters inside targets.
ParamDefinitionAttribute Attribute Declares a parameter with its command-line name, description, and resolution sources.
SecretDefinitionAttribute Attribute Declares a secret parameter that is masked in logs and can be resolved from secret stores.
ParamSource Enum The sources a parameter value can be resolved from.
ISecretsProvider Interface Retrieves secrets from a secure store.
IDotnetUserSecrets Interface Enables sourcing secrets from the .NET user secrets store.
IArtifactProvider Interface Stores and retrieves build artifacts.
IVariablesHelper Interface Helper methods for writing workflow variables from targets.
IVariableProvider Interface Reads and writes workflow variables to a specific storage backend.
IBuildInfo Interface Build name, ID, version, timestamp, and slice.
ISetupBuildInfo Interface Provides the SetupBuildInfo target.
IValidateBuild Interface Provides the ValidateBuild target.
IBuildOption Interface Marker interface for build options.
BuildOptions Class Extension anchor for fluent build option factories.
AtomHost Class Creates and runs an Atom host application.
ConfigureHostBuilderAttribute Attribute Marks a module interface as a source of host builder configuration.
IConfigureHost Interface Static host configuration hooks implemented by every generated build definition.
IAtomLifecycleHook Interface Runs code before and after target execution.
IReportsHelper Interface Adds data to the build report.
IOutcomeReportWriter Interface Writes the build outcome report to a destination.
StepFailedException Class Thrown when a step within a target fails.

Invex.Atom.Workflows

Type Kind Description
IWorkflowBuildDefinition Interface Extends IBuildDefinition with workflow definitions and the Gen target.
WorkflowBuildDefinition Class Abstract base class for partial-class workflow build definitions.
WorkflowDefinition Record A workflow's name, triggers, options, targets, and types.
WorkflowTargetDefinition Record A target within a workflow, with matrix dimensions and options.
MatrixDimension Record A named build-matrix axis and its values.
WorkflowTriggers Class Factories and presets for push, pull request, and manual triggers.
IGen Interface Provides the Gen target that writes workflow files.
IJobRunsOn Interface The runner or agent a workflow job executes on.
WorkflowBuildOptionsExtensions Class Adds BuildOptions.Inject, Artifacts, Deploy, Target, and Steps.
DebugWorkflowType Record Writes the resolved workflow model as JSON for inspection.
WorkflowOutdatedException Class Thrown in headless mode when workflow files are out of date.

Invex.Atom.Module.Dotnet

Type Kind Description
IDotnetCli Interface Strongly-typed methods for dotnet CLI commands.
IDotnetCliHelper Interface Makes the IDotnetCli service available to a build.
IDotnetPackHelper Interface Packs projects and stages the .nupkg output.
IDotnetPublishHelper Interface Publishes projects and stages the output.
IDotnetTestHelper Interface Runs test projects and reports results and coverage.
IDotnetToolInstallHelper Interface Installs .NET tools.
INugetHelper Interface NuGet feed management and push operations.
TransformProjectVersionScope Class Creates scopes that temporarily set a project file's version.

Invex.Atom.Module.GitHubWorkflows

Type Kind Description
IGitHubWorkflows Interface Integrates GitHub Actions workflows into a build.
IGitHubHelper Interface Common GitHub parameters such as the GitHub token.
GitHub Class Detects GitHub Actions and exposes its environment variables.
GitHubTrigger Record A GitHub-specific workflow trigger, such as release.
GitHubTokenPermissionsOption Record Sets fine-grained GITHUB_TOKEN permissions.
GitHubConcurrencyOption Record Configures concurrency for a GitHub Actions workflow.

Invex.Atom.Module.DevOpsWorkflows

Type Kind Description
IDevOpsWorkflows Interface Integrates Azure DevOps Pipelines into a build.
DevOps Class Detects Azure Pipelines and exposes its environment variables.
ProvideDevOpsRunIdAsWorkflowId Record Uses the Azure DevOps run ID as the workflow ID.
DevOpsConcurrencyOption Record Configures how runs waiting on an exclusive lock are handled.
DevOpsPullRequestOption Record Configures pull request auto-cancellation.

Invex.Atom.Module.AzureKeyVault

Type Kind Description
IAzureKeyVault Interface Integrates Azure Key Vault for secrets.
AzureKeyVaultValueInjections Record How each vault parameter is injected into workflows.
AzureKeyVaultValueInjectionType Enum Source for an injected vault parameter.
UseAzureKeyVault Record Build option that enables Azure Key Vault.

Invex.Atom.Module.AzureStorage

Type Kind Description
IAzureArtifactStorage Interface Configures Azure Blob Storage as the artifact store.

Invex.Atom.Module.GitVersion

Type Kind Description
IGitVersion Interface Enables GitVersion-based build identification and versioning.

Typical flow

[BuildDefinition]
[GenerateEntryPoint]
internal interface IBuild : IWorkflowBuildDefinition, IGitHubWorkflows
{
    [ParamDefinition("my-name", "My name")]
    string? MyName => GetParam(() => MyName);

    Target HelloWorld => t => t
        .RequiresParam(nameof(MyName))
        .Executes(() => Logger.LogInformation("Hello, {MyName}!", MyName));

    IReadOnlyList<WorkflowDefinition> IWorkflowBuildDefinition.Workflows =>
    [
        new("CI")
        {
            Triggers = [WorkflowTriggers.PushToMain],
            Targets = [new(nameof(HelloWorld))],
            Types = [WorkflowTypes.GitHub.Action],
        },
    ];
}

For concepts and walkthroughs, start with the Introduction.