Skip to main content
Version: Next

Categories

Sometimes we want to run only certain parts of a pipeline, or we might want to split a pipeline up into different targets. For instance, a test run, and then later on a deploy run. Categories can help achieve that.

Attribute​

Categories are applied to Modules by using the [ModuleCategory] attribute.

PipelineBuilder​

Categories to run or ignore are configured by replacing the immutable PipelineOptions snapshot with PipelineBuilder.ConfigureOptions(...).

Run-Only Categories​

If RunOnlyCategories has been set with some values, only Modules that have any of those categories will be run. If a module has none of those categories, it will not run.

Ignore Categories​

If "Ignore Categories" have been set with some values, if a Module has one of those categories, it will not run.

Category names are matched case-insensitively. Pipeline validation fails when a configured run or ignore category does not match any registered module, including when a RunOnlyCategories filter would select zero modules.

Assigning PipelineOptions.RunOnlyCategories or PipelineOptions.IgnoreCategories replaces the previous value, including values supplied through command-line options. Pass the complete filter when configuring either property.

Example of Running Specific Categories​

var builder = Pipeline.CreateBuilder(args);

builder
    .AddModule<Module1>()
    .AddModule<Module2>()
    .AddModule<Module3>()
    .AddModule<Module4>();

builder.ConfigureOptions(options => options with { RunOnlyCategories = ["UnitTest", "IntegrationTest"] });

await builder.RunAsync();

Example of Ignoring Specific Categories​

var builder = Pipeline.CreateBuilder(args);

builder
    .AddModule<Module1>()
    .AddModule<Module2>()
    .AddModule<Module3>()
    .AddModule<Module4>();

builder.ConfigureOptions(options => options with { IgnoreCategories = ["Publish", "Deploy"] });

await builder.RunAsync();