ModularPipelines.Azure.Pipelines
2.24.4
Prefix Reserved
See the version list below for details.
dotnet add package ModularPipelines.Azure.Pipelines --version 2.24.4
NuGet\Install-Package ModularPipelines.Azure.Pipelines -Version 2.24.4
<PackageReference Include="ModularPipelines.Azure.Pipelines" Version="2.24.4" />
paket add ModularPipelines.Azure.Pipelines --version 2.24.4
#r "nuget: ModularPipelines.Azure.Pipelines, 2.24.4"
// Install ModularPipelines.Azure.Pipelines as a Cake Addin #addin nuget:?package=ModularPipelines.Azure.Pipelines&version=2.24.4 // Install ModularPipelines.Azure.Pipelines as a Cake Tool #tool nuget:?package=ModularPipelines.Azure.Pipelines&version=2.24.4
ModularPipelines
Define your pipeline in .NET! Strong types, intellisense, parallelisation, and the entire .NET ecosystem at your fingertips.
Documentation
https://thomhurst.github.io/ModularPipelines
Features
- Parallel execution
- Dependency management
- Familiar C# code
- Ability to debug pipelines
- Ability to run pipelines locally, even creating versions for setting up local development
- Strong typing, where different modules/steps can pass data to one another
- Dependency collision detection - Don't worry about accidentally making two modules dependent on each other
- Numerous helpers to do things like: Search files, check checksums, (un)zip folders, download files, install files, execute CLI commands, hash data, and more
- Easy to Skip or Ignore Failures for each individual module by passing in custom logic
- Hooks that can run before and/or after modules
- Pipeline requirements - Validate your requirements are met before executing your pipeline, such as a Linux operating system
- Easy to use File and Folder classes, that can search, read, update, delete and more
- Source controlled pipelines
- Build agent agnostic - Can easily move to a different build system without completely recreating your pipeline
- No need to learn new syntaxes such as YAML defined pipelines
- Strongly typed wrappers around command line tools
- Utilise existing .NET libraries
- Secret obfuscation
- Grouped logging, and the ability to extend sources by adding to the familiar
ILogger
- Run based on categories
- Easy to read exceptions
- Dynamic console progress reporting (if the console supports interactive mode)
- Pretty results table
Available Modules
Getting Started
If you want to see how to get started, or want to know more about ModularPipelines, read the Documentation here
Console Progress
Results
<img width="444" alt="image" src="https://github.com/thomhurst/ModularPipelines/assets/30480171/8963e891-2c29-4382-9a3e-6ced4daf4d4b">
How does this compare to Cake / Nuke
- Strong types! You have complete control over what data, and what shape of data to pass around from and to different modules
- No external tooling is required. Pipelines are run with a simple
dotnet run
- Full dependency injection support for your services
- Similar and familiar setup to frameworks like ASP.NET Core
- Real C# - Whereas frameworks like cake are a scripted form of C#
- Parallelism - Work will run concurrently unless it is dependent on something else
- The style of writing pipelines is very different - Work is organised into separate module classes, keeping code organised and more closely following SRP than having all your work in one main class. This also helps multiple contributors avoid things like merge conflicts
Code Examples
Program.cs - Main method
await PipelineHostBuilder.Create()
.ConfigureAppConfiguration((context, builder) =>
{
builder.AddJsonFile("appsettings.json")
.AddUserSecrets<Program>()
.AddEnvironmentVariables();
})
.ConfigureServices((context, collection) =>
{
collection.Configure<NuGetSettings>(context.Configuration.GetSection("NuGet"));
collection.Configure<PublishSettings>(context.Configuration.GetSection("Publish"));
collection.AddSingleton<ISomeService1, SomeService1>();
collection.AddTransient<ISomeService2, SomeService2>();
})
.AddModule<FindNugetPackagesModule>()
.AddModule<UploadNugetPackagesModule>()
.ExecutePipelineAsync();
Custom Modules
public class FindNugetPackagesModule : Module<FileInfo>
{
protected override Task<List<File>?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
{
return context.Git()
.RootDirectory
.GetFiles(path => path.Extension is ".nupkg")
.ToList()
.AsTask();
}
}
[DependsOn<FindNugetPackagesModule>]
public class UploadNugetPackagesModule : Module<FileInfo>
{
private readonly IOptions<NuGetSettings> _nugetSettings;
public UploadNugetPackagesModule(IOptions<NuGetSettings> nugetSettings)
{
_nugetSettings = nugetSettings;
}
protected override async Task<CommandResult?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
{
var nugetFiles = await GetModule<FindNugetPackagesModule>();
return await context.NuGet()
.UploadPackages(new NuGetUploadOptions(nugetFiles.Value!.AsPaths(), new Uri("https://api.nuget.org/v3/index.json"))
{
ApiKey = _nugetSettings.Value.ApiKey
});
}
}
Breaking changes
While I will try to limit breaking changes, there may be some changes within minor versions. These will be noted on release notes.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- ModularPipelines (>= 2.24.4)
-
net7.0
- ModularPipelines (>= 2.24.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.42.87 | 73 | 10/28/2024 |
2.42.67 | 90 | 9/29/2024 |
2.42.59 | 86 | 9/19/2024 |
2.42.54 | 79 | 9/19/2024 |
2.42.53 | 75 | 9/19/2024 |
2.42.47 | 90 | 9/13/2024 |
2.42.45 | 89 | 9/12/2024 |
2.42.9 | 97 | 9/5/2024 |
2.42.8 | 91 | 9/4/2024 |
2.42.0 | 95 | 9/4/2024 |
2.41.4 | 93 | 9/3/2024 |
2.41.0 | 100 | 9/3/2024 |
2.40.18 | 93 | 9/2/2024 |
2.40.15 | 91 | 9/2/2024 |
2.40.10 | 92 | 9/2/2024 |
2.40.8 | 85 | 9/2/2024 |
2.40.4 | 79 | 8/29/2024 |
2.40.1 | 95 | 8/28/2024 |
2.38.36 | 93 | 8/26/2024 |
2.38.25 | 110 | 8/12/2024 |
2.38.2 | 70 | 7/27/2024 |
2.38.1 | 79 | 7/27/2024 |
2.37.9 | 90 | 7/14/2024 |
2.36.29 | 98 | 7/5/2024 |
2.36.23 | 93 | 6/30/2024 |
2.36.4 | 91 | 6/7/2024 |
2.35.0 | 90 | 6/2/2024 |
2.34.0 | 106 | 5/23/2024 |
2.33.0 | 105 | 5/20/2024 |
2.32.0 | 109 | 5/17/2024 |
2.31.3 | 123 | 4/15/2024 |
2.31.0 | 111 | 4/15/2024 |
2.30.9 | 126 | 3/27/2024 |
2.30.5 | 116 | 3/26/2024 |
2.30.3 | 144 | 3/26/2024 |
2.29.32 | 139 | 3/26/2024 |
2.29.22 | 181 | 3/8/2024 |
2.29.15 | 247 | 3/1/2024 |
2.29.11 | 191 | 2/27/2024 |
2.29.9 | 217 | 2/26/2024 |
2.29.0 | 224 | 2/25/2024 |
2.28.0 | 218 | 2/23/2024 |
2.27.12 | 192 | 2/15/2024 |
2.27.9 | 237 | 2/14/2024 |
2.27.3 | 252 | 2/8/2024 |
2.27.0 | 242 | 2/8/2024 |
2.26.8 | 232 | 2/4/2024 |
2.26.0 | 238 | 1/29/2024 |
2.25.0 | 267 | 1/28/2024 |
2.24.9 | 280 | 1/25/2024 |
2.24.4 | 229 | 1/25/2024 |
2.24.1 | 291 | 1/22/2024 |
2.22.0 | 285 | 1/18/2024 |
2.21.12 | 263 | 1/18/2024 |
2.21.9 | 298 | 1/18/2024 |
2.21.4 | 295 | 1/13/2024 |
2.21.0 | 289 | 1/12/2024 |
2.20.2 | 267 | 1/11/2024 |
2.19.2 | 378 | 12/27/2023 |
2.19.0 | 309 | 12/26/2023 |
2.18.8 | 286 | 12/26/2023 |
2.18.0 | 343 | 12/24/2023 |
2.17.25 | 345 | 12/22/2023 |
2.17.20 | 433 | 12/5/2023 |
2.17.0 | 421 | 11/24/2023 |
2.16.2 | 428 | 11/23/2023 |
2.16.0 | 373 | 11/23/2023 |
2.15.24 | 356 | 11/22/2023 |
2.15.21 | 413 | 11/22/2023 |
2.15.17 | 370 | 11/20/2023 |
2.15.3 | 410 | 11/9/2023 |
2.15.0 | 312 | 11/8/2023 |
2.14.9 | 355 | 11/6/2023 |
2.14.7 | 410 | 11/6/2023 |
2.14.1 | 387 | 11/6/2023 |
2.13.63 | 392 | 10/29/2023 |
2.13.47 | 406 | 10/20/2023 |
2.13.8 | 374 | 10/13/2023 |
2.13.5 | 409 | 10/13/2023 |
2.12.15 | 381 | 10/10/2023 |
2.12.11 | 472 | 10/10/2023 |
2.12.5 | 448 | 10/6/2023 |
2.12.1 | 406 | 10/4/2023 |
2.11.12 | 411 | 10/1/2023 |
2.11.11 | 378 | 9/30/2023 |
2.11.9 | 449 | 9/30/2023 |
2.11.4 | 459 | 9/30/2023 |
2.11.0 | 476 | 9/29/2023 |
2.10.6 | 403 | 9/29/2023 |
2.10.0 | 419 | 9/28/2023 |
2.9.0 | 403 | 9/28/2023 |
2.8.23 | 401 | 9/26/2023 |
2.8.12 | 425 | 9/24/2023 |
2.8.4 | 436 | 9/24/2023 |
2.8.0 | 416 | 9/24/2023 |
2.7.10 | 457 | 9/23/2023 |
2.7.6 | 420 | 9/22/2023 |
2.6.0 | 441 | 9/19/2023 |
2.5.11 | 394 | 9/16/2023 |
2.5.5 | 405 | 9/14/2023 |
2.5.2 | 438 | 9/14/2023 |
2.5.0 | 403 | 9/14/2023 |
2.4.0 | 401 | 9/12/2023 |
2.3.2 | 447 | 9/11/2023 |
2.3.0 | 435 | 9/11/2023 |
2.2.0 | 409 | 9/11/2023 |
2.0.8 | 540 | 9/7/2023 |
2.0.5 | 479 | 9/6/2023 |
2.0.0 | 479 | 9/6/2023 |
1.9.38 | 462 | 9/5/2023 |
1.9.36 | 431 | 9/5/2023 |
1.9.35 | 432 | 9/4/2023 |
1.9.31 | 399 | 9/4/2023 |
1.9.28 | 460 | 9/4/2023 |
1.9.22 | 491 | 9/3/2023 |
1.9.17 | 534 | 9/3/2023 |
1.9.15 | 483 | 9/3/2023 |
1.9.8 | 486 | 9/1/2023 |
1.9.6 | 523 | 9/1/2023 |
1.9.4 | 464 | 9/1/2023 |
1.9.1 | 428 | 8/31/2023 |
1.8.22 | 466 | 8/29/2023 |
1.8.18 | 475 | 8/29/2023 |
1.8.8 | 515 | 8/24/2023 |
1.8.6 | 442 | 8/24/2023 |
1.7.0 | 500 | 8/22/2023 |
1.6.3 | 457 | 8/17/2023 |
1.6.2 | 532 | 8/17/2023 |
1.6.1 | 509 | 8/17/2023 |
1.6.0 | 522 | 8/17/2023 |
1.5.5 | 491 | 8/15/2023 |
1.5.0 | 517 | 8/14/2023 |
1.4.34 | 520 | 8/11/2023 |
1.4.33 | 470 | 8/11/2023 |
1.4.31 | 534 | 8/11/2023 |
1.4.29 | 514 | 8/10/2023 |
1.4.22 | 565 | 8/10/2023 |
1.4.21 | 517 | 8/10/2023 |
1.4.20 | 507 | 8/10/2023 |
1.4.18 | 501 | 8/7/2023 |
1.4.17 | 552 | 8/7/2023 |
1.4.15 | 483 | 8/7/2023 |
1.4.14 | 608 | 8/2/2023 |
1.4.12 | 498 | 8/2/2023 |
1.4.11 | 551 | 7/19/2023 |
1.4.10 | 629 | 7/19/2023 |
1.4.9 | 536 | 7/18/2023 |
1.4.8 | 511 | 7/18/2023 |
1.4.6 | 568 | 7/13/2023 |
1.4.5 | 520 | 7/11/2023 |
1.4.4 | 525 | 7/10/2023 |
1.4.3 | 539 | 7/10/2023 |
1.4.2 | 554 | 7/7/2023 |
1.4.1 | 463 | 7/6/2023 |
1.4.0 | 556 | 7/6/2023 |
1.3.17 | 570 | 7/5/2023 |
1.3.15 | 645 | 7/5/2023 |
1.3.14 | 484 | 7/5/2023 |
1.3.13 | 590 | 7/5/2023 |
1.3.12 | 644 | 6/30/2023 |
1.3.11 | 493 | 6/30/2023 |
1.3.8 | 523 | 6/30/2023 |
1.3.7 | 548 | 6/30/2023 |
1.3.6 | 596 | 6/30/2023 |
1.3.5 | 533 | 6/30/2023 |
1.3.4 | 514 | 6/30/2023 |
1.3.3 | 461 | 6/29/2023 |
1.3.2 | 599 | 6/29/2023 |
1.3.1 | 553 | 6/29/2023 |
1.3.0 | 553 | 6/29/2023 |
1.2.0 | 587 | 6/29/2023 |
1.1.0 | 615 | 6/29/2023 |
1.0.1 | 542 | 6/29/2023 |
0.3.26 | 564 | 6/29/2023 |
0.2.0 | 611 | 6/29/2023 |
0.1.1-initial-2-0027 | 506 | 6/8/2023 |
0.1.1-initial-2-0025 | 502 | 6/8/2023 |
0.1.1-initial-2-0024 | 502 | 6/8/2023 |
0.1.0 | 562 | 6/28/2023 |
0.1.0-initial-2-19 | 516 | 6/8/2023 |
0.1.0-initial-2-17 | 487 | 6/8/2023 |
0.1.0-initial-2-16 | 548 | 6/8/2023 |
0.1.0-initial-2-0023 | 455 | 6/8/2023 |