Skip to content

Update ModularPipelines to v3 (major) #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Nice3point wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update ModularPipelines to v3 (major) #123

Nice3point wants to merge 1 commit into from
+12 −12

Conversation

@Nice3point
Copy link
Owner

@Nice3point Nice3point commented Jan 17, 2026 •
edited
Loading

ℹ️ Note

This PR body was truncated due to platform limits.

This PR contains the following updates:

Package Type Update Change
ModularPipelines nuget major 2.48.30 → 3.1.6
ModularPipelines.DotNet nuget major 2.48.30 → 3.1.6
ModularPipelines.Git nuget major 2.48.30 → 3.1.6
ModularPipelines.GitHub nuget major 2.48.30 → 3.1.6

Release Notes

thomhurst/ModularPipelines (ModularPipelines)

v3.1.6: 3.1.6

What's Changed
  • fix(progress): preserve AlwaysRun module tasks during progress session disposal by @​thomhurst in #​2236

Full Changelog: thomhurst/ModularPipelines@v3.1.5...v3.1.6

v3.1.5: 3.1.5

What's Changed

Full Changelog: thomhurst/ModularPipelines@v3.1.4...v3.1.5

v3.1.0: 3.1.0

What's Changed

Full Changelog: thomhurst/ModularPipelines@v3.0.125...v3.1.0

v3.0.124: 3.0.124

What's Changed

Full Changelog: thomhurst/ModularPipelines@v3.0.123...v3.0.124

v3.0.86: 3.0.86

What's Changed

Full Changelog: thomhurst/ModularPipelines@v3.0.84...v3.0.86

v3.0.1: 3.0.1

What's Changed

Full Changelog: thomhurst/ModularPipelines@v3.0.0...v3.0.1

v3.0.0: 3.0.0

ModularPipelines V3 Release Notes
Highlights
ASP.NET Core-Style Builder Pattern

No more callbacks. Direct property access, just like ASP.NET Core minimal APIs.

// Before (V2)
await PipelineHostBuilder.Create()
    .ConfigureAppConfiguration((context, builder) => { ... })
    .ConfigureServices((context, collection) => { ... })
    .ExecutePipelineAsync();

// After (V3)
var builder = Pipeline.CreateBuilder(args);
builder.Configuration.AddJsonFile("appsettings.json");
builder.Services.AddModule<BuildModule>();
await builder.Build().RunAsync();

If you've used ASP.NET Core, this feels instantly familiar.

Fluent Module Configuration

Configure module behavior with a clean, fluent API instead of scattered property overrides.

// Before (V2) - properties scattered across the class
protected internal override TimeSpan Timeout => TimeSpan.FromMinutes(5);
protected override AsyncRetryPolicy<string?> RetryPolicy => ...;
protected internal override Task<SkipDecision> ShouldSkip(...) => ...;

// After (V3) - everything in one place
protected override ModuleConfiguration Configure() => ModuleConfiguration.Create()
    .WithTimeout(TimeSpan.FromMinutes(5))
    .WithRetryCount(3)
    .WithSkipWhen(ctx => ctx.Git().Information.BranchName != "main"
        ? SkipDecision.Skip("Only runs on main")
        : SkipDecision.DoNotSkip)
    .Build();
Type-Safe Result Handling

Module results are now discriminated unions. Pattern matching gives you compile-time safety.

var result = await context.GetModule<BuildModule>();

return result switch
{
    ModuleResult<BuildOutput>.Success { Value: var output } => Deploy(output),
    ModuleResult.Skipped => null,
    ModuleResult.Failure { Exception: var ex } => throw ex,
    _ => null
};

Or use the simpler helpers for quick migrations:

if (result.IsSuccess)
{
    var value = result.ValueOrDefault;
}
New Features
Non-Generic Module Classes

New Module and SyncModule base classes for modules that don't return data.

// Async module - no return value needed
public class DeployModule : Module
{
    protected override async Task ExecuteModuleAsync(
        IModuleContext context, CancellationToken cancellationToken)
    {
        await context.Command.ExecuteCommandLineTool(...);
    }
}

// Sync module - no return value needed
public class LoggingModule : SyncModule
{
    protected override void ExecuteModule(
        IModuleContext context, CancellationToken cancellationToken)
    {
        context.Logger.LogInformation("Done!");
    }
}

Internally these use the None struct, which represents "nothing" and is semantically equivalent to null.

Dynamic Dependencies

Declare dependencies programmatically based on runtime conditions.

protected override void DeclareDependencies(IDependencyDeclaration deps)
{
    deps.DependsOn<RequiredModule>();
    deps.DependsOnOptional<OptionalModule>();
    deps.DependsOnIf<ProductionModule>(Environment.IsProduction);
}
Powerful Dependency Attributes
// Depend on all modules in a category
[DependsOnModulesInCategory("Build")]
public class TestModule : Module<TestResults> { }

// Depend on all modules with a tag
[DependsOnModulesWithTag("database")]
public class MigrationModule : Module<bool> { }
Conditional Execution Attributes
[RunOnLinux]
public class LinuxModule : Module<string> { }

[RunOnWindowsOnly]  // Skips on other platforms
public class WindowsOnlyModule : Module<string> { }

[SkipIf(typeof(IsNotMainBranchCondition))]
public class MainBranchModule : Module<string> { }

[RunIfAll(typeof(IsCI), typeof(IsMainBranch))]
public class CIMainModule : Module<string> { }
Module Tags and Categories

Organize modules for easier management.

[ModuleTag("critical")]
[ModuleTag("deployment")]
[ModuleCategory("Infrastructure")]
public class DeployModule : Module<DeployResult> { }
Pipeline Validation

Catch configuration errors before execution.

var validation = await builder.ValidateAsync();
if (validation.HasErrors)
{
    foreach (var error in validation.Errors)
    {
        Console.WriteLine($"[{error.Category}] {error.Message}");
    }
}
Plugin System

Create reusable pipeline extensions.

public class MyPlugin : IModularPipelinesPlugin
{
    public string Name => "MyPlugin";

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddSingleton<IMyService, MyService>();
    }

    public void ConfigurePipeline(PipelineBuilder builder)
    {
        builder.Services.AddModule<PluginModule>();
    }
}

[assembly: ModularPipelinesPlugin(typeof(MyPlugin))]
Enhanced Lifecycle Hooks

New overridable methods for fine-grained control.

protected override Task OnBeforeExecuteAsync(IModuleContext context, CancellationToken ct) { }
protected override Task OnAfterExecuteAsync(IModuleContext context, ModuleResult<T> result, CancellationToken ct) { }
protected override Task OnSkippedAsync(IModuleContext context, SkipDecision decision, CancellationToken ct) { }
protected override Task OnFailedAsync(IModuleContext context, Exception ex, CancellationToken ct) { }
Breaking Changes
Entry Point
V2 V3
PipelineHostBuilder.Create() Pipeline.CreateBuilder(args)
.ConfigureAppConfiguration(callback) builder.Configuration
.ConfigureServices(callback) builder.Services
.ConfigurePipelineOptions(callback) builder.Options
.AddModule<T>() on builder builder.Services.AddModule<T>()
.ExecutePipelineAsync() .Build().RunAsync()
Module API
V2 V3
IPipelineContext in ExecuteAsync IModuleContext
GetModule<T>() on module context.GetModule<T>()
Timeout property override Configure().WithTimeout()
RetryPolicy property override Configure().WithRetryCount()
ShouldSkip() method Configure().WithSkipWhen()
ShouldIgnoreFailures() method Configure().WithIgnoreFailures()
ModuleRunType.AlwaysRun Configure().WithAlwaysRun()
OnBeforeExecute() Configure().WithBeforeExecute() or OnBeforeExecuteAsync()
OnAfterExecute() Configure().WithAfterExecute() or OnAfterExecuteAsync()
Result Access
V2 V3
result.Value result.ValueOrDefault or pattern match
result.Exception result.ExceptionOrDefault or pattern match
result.ModuleResultType == ModuleResultType.Success result.IsSuccess or pattern match
Command Execution

Execution-related properties moved from tool options to a separate CommandExecutionOptions parameter:

V2 (on tool options) V3 (on CommandExecutionOptions)
WorkingDirectory WorkingDirectory
EnvironmentVariables EnvironmentVariables
ThrowOnNonZeroExitCode ThrowOnNonZeroExitCode 
// V3: Pass execution options as second parameter
await context.DotNet().Build(
    new DotNetBuildOptions { Configuration = "Release" },
    new CommandExecutionOptions { WorkingDirectory = "/app" });
Removed Types
  • PipelineHostBuilder - Use Pipeline.CreateBuilder()
  • ModuleBase / ModuleBase<T> - Use Module<T>
Migration Path
Quick Migration (Minimal Changes)

The ExecutePipelineAsync() extension still exists:

var builder = Pipeline.CreateBuilder(args);
builder.Services.AddModule<MyModule>();
await builder.ExecutePipelineAsync();  // Still works

And ValueOrDefault provides backwards-compatible result access:

var result = await context.GetModule<BuildModule>();
var value = result.ValueOrDefault;  // Similar to old result.Value
Full Migration

For the cleanest code, adopt the new patterns:

  1. Use Pipeline.CreateBuilder(args) with direct property access
  2. Move module configuration to Configure() builder
  3. Change IPipelineContext to IModuleContext
  4. Move GetModule<T>() calls to context
  5. Use pattern matching for result handling

See the Migration Guide for detailed examples.

Upgrade Steps
  1. Update the NuGet package: dotnet add package ModularPipelines --version 3.0.0
  2. Fix compile errors using the migration tables above
  3. (Optional) Refactor to use new fluent APIs
  4. (Optional) Adopt new features like tags, categories, and conditional attributes
Getting Help
What's Changed

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

Copilot AI review requested due to automatic review settings January 17, 2026 11:22
@Nice3point Nice3point added the maintenance ⚙️ Some regular maintenance updates label Jan 17, 2026
Copilot AI reviewed Jan 17, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates ModularPipelines packages from version 2.48.30 to 3.0.1, which is a major version upgrade with significant breaking API changes. However, the code has not been migrated to accommodate these breaking changes.

Changes:

  • Updated ModularPipelines package references from v2.48.30 to v3.0.1 across all build projects
  • Updated ModularPipelines.Git, ModularPipelines.DotNet, and ModularPipelines.GitHub packages to v3.0.1

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
build/Build.csproj Updated ModularPipelines package versions to 3.0.1 for the main build project
samples/MultiProjectSolution/build/Build.csproj Updated ModularPipelines package versions to 3.0.1 for the sample project
source/Nice3point.Revit.Templates/Nice3point.Revit.AddIn.Solution/build/Build.csproj Updated ModularPipelines package versions to 3.0.1 for the template project

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

build/Build.csproj Outdated
Comment on lines 11 to 14
<PackageReference Include="ModularPipelines" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.Git" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.GitHub" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.DotNet" Version="3.0.1"/>
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR updates ModularPipelines from v2.48.30 to v3.0.1, which is a major version update with significant breaking changes. However, the code has not been updated to handle these breaking changes. The following migration steps are required:

  1. PipelineHostBuilder API: All Program.cs files use PipelineHostBuilder.Create() which has been replaced with Pipeline.CreateBuilder(args) in v3. The configuration pattern has also changed from callbacks to direct property access.

  2. Module Context: All modules use IPipelineContext which has been renamed to IModuleContext in v3.

  3. GetModule calls: All modules call GetModule<T>() directly on the module instance, but in v3 this must be called on the context: context.GetModule<T>().

  4. Result access: Module results now use discriminated unions. Code accessing result.Value should use result.ValueOrDefault or pattern matching.

  5. ShouldIgnoreFailures: The ShouldIgnoreFailures() method override in RestoreTemplatesReadmeModule needs to be moved to the Configure() method using .WithIgnoreFailures().

  6. OnAfterExecute: The OnAfterExecute() method overrides in PublishGithubModule need to be migrated to either Configure().WithAfterExecute() or OnAfterExecuteAsync().

  7. ModuleRunType.AlwaysRun: The ModuleRunType.AlwaysRun property in RestoreTemplatesReadmeModule needs to be moved to Configure().WithAlwaysRun().

Without these changes, the build will fail to compile. Please refer to the ModularPipelines v3 migration guide for detailed examples of each change.

Suggested change
<PackageReference Include="ModularPipelines" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.Git" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.GitHub" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.DotNet" Version="3.0.1"/>
<PackageReference Include="ModularPipelines" Version="2.48.30"/>
<PackageReference Include="ModularPipelines.Git" Version="2.48.30"/>
<PackageReference Include="ModularPipelines.GitHub" Version="2.48.30"/>
<PackageReference Include="ModularPipelines.DotNet" Version="2.48.30"/>

Copilot uses AI. Check for mistakes.
samples/MultiProjectSolution/build/Build.csproj Outdated
Comment on lines 14 to 17
<PackageReference Include="ModularPipelines" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.Git" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.GitHub" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.DotNet" Version="3.0.1"/>
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR updates ModularPipelines from v2.48.30 to v3.0.1, which is a major version update with significant breaking changes. However, the code has not been updated to handle these breaking changes. The following migration steps are required:

  1. PipelineHostBuilder API: Program.cs uses PipelineHostBuilder.Create() which has been replaced with Pipeline.CreateBuilder(args) in v3. The configuration pattern has also changed from callbacks to direct property access.

  2. Module Context: All modules use IPipelineContext which has been renamed to IModuleContext in v3.

  3. GetModule calls: All modules call GetModule<T>() directly on the module instance, but in v3 this must be called on the context: context.GetModule<T>().

  4. Result access: Module results now use discriminated unions. Code accessing result.Value should use result.ValueOrDefault or pattern matching.

  5. OnAfterExecute: The OnAfterExecute() method override in PublishGithubModule needs to be migrated to either Configure().WithAfterExecute() or OnAfterExecuteAsync().

Without these changes, the build will fail to compile. Please refer to the ModularPipelines v3 migration guide for detailed examples of each change.

Suggested change
<PackageReference Include="ModularPipelines" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.Git" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.GitHub" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.DotNet" Version="3.0.1"/>
<PackageReference Include="ModularPipelines" Version="2.48.30"/>
<PackageReference Include="ModularPipelines.Git" Version="2.48.30"/>
<PackageReference Include="ModularPipelines.GitHub" Version="2.48.30"/>
<PackageReference Include="ModularPipelines.DotNet" Version="2.48.30"/>

Copilot uses AI. Check for mistakes.
source/Nice3point.Revit.Templates/Nice3point.Revit.AddIn.Solution/build/Build.csproj Outdated
Comment on lines 14 to 18
<PackageReference Include="ModularPipelines" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.Git" Version="3.0.1"/>
<PackageReference Include="ModularPipelines.DotNet" Version="3.0.1"/>
<!--#if (isGitHubCi)-->
<PackageReference Include="ModularPipelines.GitHub" Version="2.48.30"/>
<PackageReference Include="ModularPipelines.GitHub" Version="3.0.1"/>
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR updates ModularPipelines from v2.48.30 to v3.0.1, which is a major version update with significant breaking changes. However, the template code has not been updated to handle these breaking changes. The following migration steps are required:

  1. PipelineHostBuilder API: Program.cs uses PipelineHostBuilder.Create() which has been replaced with Pipeline.CreateBuilder(args) in v3. The configuration pattern has also changed from callbacks to direct property access.

  2. Module Context: All modules use IPipelineContext which has been renamed to IModuleContext in v3.

  3. GetModule calls: All modules call GetModule<T>() directly on the module instance, but in v3 this must be called on the context: context.GetModule<T>().

  4. Result access: Module results now use discriminated unions. Code accessing result.Value should use result.ValueOrDefault or pattern matching.

  5. OnAfterExecute: The OnAfterExecute() method override in PublishGithubModule needs to be migrated to either Configure().WithAfterExecute() or OnAfterExecuteAsync().

Without these changes, the template will generate code that fails to compile. Please refer to the ModularPipelines v3 migration guide for detailed examples of each change.

Copilot uses AI. Check for mistakes.
@Nice3point Nice3point force-pushed the renovate/major-modularpipelines branch 4 times, most recently from aff376f to 881e3c5 Compare January 19, 2026 12:55
@Nice3point Nice3point force-pushed the renovate/major-modularpipelines branch from 881e3c5 to 48a5812 Compare January 20, 2026 01:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

maintenance ⚙️ Some regular maintenance updates

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Nice3point @renovate-bot