ModularPipelines.Azure 2.28.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package ModularPipelines.Azure --version 2.28.0
NuGet\Install-Package ModularPipelines.Azure -Version 2.28.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ModularPipelines.Azure" Version="2.28.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ModularPipelines.Azure --version 2.28.0
#r "nuget: ModularPipelines.Azure, 2.28.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ModularPipelines.Azure as a Cake Addin
#addin nuget:?package=ModularPipelines.Azure&version=2.28.0

// Install ModularPipelines.Azure as a Cake Tool
#tool nuget:?package=ModularPipelines.Azure&version=2.28.0

ModularPipelines

Define your pipeline in .NET! Strong types, intellisense, parallelisation, and the entire .NET ecosystem at your fingertips.

nuget

Nuget GitHub Workflow Status (with event) GitHub last commit (branch) Codacy Badge CodeFactor License Codacy Badge codecov

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

Package Description Version
ModularPipelines Write your pipelines in C#! nuget
ModularPipelines.AmazonWebServices Helpers for interacting with Amazon Web Services. nuget
ModularPipelines.Azure Helpers for interacting with Azure. nuget
ModularPipelines.Azure.Pipelines Helpers for interacting with Azure Pipeline agents. nuget
ModularPipelines.Chocolatey Helpers for interacting with the Chocolatey CLI. nuget
ModularPipelines.Cmd Helpers for interacting with the Windows cmd process. nuget
ModularPipelines.Docker Helpers for interacting with the Docker CLI. nuget
ModularPipelines.DotNet Helpers for interacting with dotnet CLI. nuget
ModularPipelines.Email Helpers for sending emails. nuget
ModularPipelines.Ftp Helpers for downloading and uploading via FTP. nuget
ModularPipelines.Git Helpers for interacting with git. nuget
ModularPipelines.GitHub Helpers for interacting with GitHub Actions build agents. nuget
ModularPipelines.Google Helpers for interacting with the Google gcloud CLI. nuget
ModularPipelines.Helm Helpers for interacting with Helm CLI. nuget
ModularPipelines.Kubernetes Helpers for interacting with kubectl CLI. nuget
ModularPipelines.MicrosoftTeams Helpers for sending Microsoft Teams cards. nuget
ModularPipelines.Node Helpers for interacting with node / npm CLI. nuget
ModularPipelines.Slack Helpers for sending Slack cards. nuget
ModularPipelines.TeamCity Helpers for interacting with TeamCity build agents. nuget
ModularPipelines.Terraform Helpers for interacting with Terraform CLI. nuget
ModularPipelines.WinGet Helpers for interacting with the Windows Package Manager. nuget
ModularPipelines.Yarn Helpers for interacting with Yarn CLI. nuget

Getting Started

If you want to see how to get started, or want to know more about ModularPipelines, read the Documentation here

Console Progress

image

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 nugetFiles.Value!
            .SelectAsync(async nugetFile => await context.DotNet().Nuget.Push(new DotNetNugetPushOptions
            {
                Path = nugetFile,
                Source = "https://api.nuget.org/v3/index.json",
                ApiKey = _nugetSettings.Value.ApiKey!,
            }, cancellationToken), cancellationToken: cancellationToken)
            .ProcessOneAtATime();
    }
}

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 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 is compatible.  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. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

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.28.0 56 2/23/2024
2.27.12 40 2/15/2024
2.27.9 39 2/14/2024
2.27.3 54 2/8/2024
2.27.0 34 2/8/2024
2.26.8 40 2/4/2024
2.26.0 49 1/29/2024
2.25.0 43 1/28/2024
2.24.9 47 1/25/2024
2.24.4 37 1/25/2024
2.24.1 42 1/22/2024
2.22.0 44 1/18/2024
2.21.12 38 1/18/2024
2.21.9 48 1/18/2024
2.21.4 58 1/13/2024
2.21.0 43 1/12/2024
2.20.2 77 1/11/2024
2.19.2 99 12/27/2023
2.19.0 65 12/26/2023
2.18.8 55 12/26/2023
2.18.0 72 12/24/2023
2.17.25 75 12/22/2023
2.17.20 85 12/5/2023
2.17.0 67 11/24/2023
2.16.2 55 11/23/2023
2.16.0 57 11/23/2023
2.15.24 55 11/22/2023
2.15.21 52 11/22/2023
2.15.17 55 11/20/2023
2.15.3 55 11/9/2023
2.15.0 35 11/8/2023
2.14.9 57 11/6/2023
2.14.7 53 11/6/2023
2.14.1 56 11/6/2023
2.13.63 64 10/29/2023
2.13.47 58 10/20/2023
2.13.8 76 10/13/2023
2.13.5 65 10/13/2023
2.12.15 61 10/10/2023
2.12.11 60 10/10/2023
2.12.5 68 10/6/2023
2.12.1 63 10/4/2023
2.11.12 64 10/1/2023
2.11.11 61 9/30/2023
2.11.9 63 9/30/2023
2.11.4 60 9/30/2023
2.11.0 66 9/29/2023
2.10.6 57 9/29/2023
2.10.0 55 9/28/2023
2.9.0 55 9/28/2023
2.8.23 57 9/26/2023
2.8.12 66 9/24/2023
2.8.4 58 9/24/2023
2.8.0 60 9/24/2023
2.7.10 57 9/23/2023
2.7.6 59 9/22/2023
2.6.0 65 9/19/2023
2.5.11 61 9/16/2023
2.5.5 76 9/14/2023
2.5.2 78 9/14/2023
2.5.0 54 9/14/2023
2.4.0 71 9/12/2023
2.3.2 74 9/11/2023
2.3.0 69 9/11/2023
2.2.0 72 9/11/2023
2.0.8 77 9/7/2023
2.0.5 68 9/6/2023
2.0.0 72 9/6/2023
1.9.38 71 9/5/2023
1.9.36 56 9/5/2023
1.9.35 69 9/4/2023
1.9.31 67 9/4/2023
1.9.28 72 9/4/2023
1.9.22 70 9/3/2023
1.9.17 70 9/3/2023
1.9.15 68 9/3/2023
1.9.8 83 9/1/2023
1.9.6 76 9/1/2023
1.9.4 78 9/1/2023
1.9.1 85 8/31/2023
1.8.22 93 8/29/2023
1.8.18 87 8/29/2023
1.8.8 82 8/24/2023
1.8.6 78 8/24/2023
1.7.0 75 8/22/2023
1.6.3 80 8/17/2023
1.6.2 80 8/17/2023
1.6.1 79 8/17/2023
1.6.0 82 8/17/2023
1.5.5 87 8/15/2023
1.5.0 80 8/14/2023
1.4.34 88 8/11/2023
1.4.33 92 8/11/2023
1.4.31 91 8/11/2023
1.4.29 85 8/10/2023
1.4.22 93 8/10/2023
1.4.21 101 8/10/2023
1.4.20 89 8/10/2023
1.4.18 94 8/7/2023
1.4.17 93 8/7/2023
1.4.15 92 8/7/2023
1.4.14 108 8/2/2023
1.4.12 96 8/2/2023