ModularPipelines.Azure 2.6.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package ModularPipelines.Azure --version 2.6.0
NuGet\Install-Package ModularPipelines.Azure -Version 2.6.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.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ModularPipelines.Azure --version 2.6.0
#r "nuget: ModularPipelines.Azure, 2.6.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.6.0

// Install ModularPipelines.Azure as a Cake Tool
#tool nuget:?package=ModularPipelines.Azure&version=2.6.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 License Codacy Badge

Features

  • Parallel execution with easy waiting on dependencies if necessary
  • 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
  • Dynamic console progress reporting (if the console supports interactive mode)

Available Modules

Package Version
ModularPipelines nuget
ModularPipelines.Azure nuget
ModularPipelines.Azure.Pipelines nuget
ModularPipelines.Cmd nuget
ModularPipelines.Docker nuget
ModularPipelines.DotNet nuget
ModularPipelines.Email nuget
ModularPipelines.Ftp nuget
ModularPipelines.Git nuget
ModularPipelines.Helm nuget
ModularPipelines.Kubernetes nuget
ModularPipelines.MicrosoftTeams nuget
ModularPipelines.Node nuget
ModularPipelines.NuGet nuget
ModularPipelines.Slack nuget
ModularPipelines.Terraform nuget

Getting Started

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

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"));
    })
    .AddModule<FindNugetPackagesModule>()
    .AddModule<UploadNugetPackagesModule>()
    .ExecutePipelineAsync();

Custom Modules

public class FindNugetPackagesModule : Module<FileInfo>
{
    protected override async Task<List<File>?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
    {
        await Task.Yield();

        return context.Git()
            .RootDirectory
            .GetFiles(path => path.Extension is ".nupkg")
            .ToList();
    }
}
[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(packagePaths.Value!.AsPaths(), new Uri("https://api.nuget.org/v3/index.json"))
            {
                ApiKey = _nugetSettings.Value.ApiKey,
                NoSymbols = true
            });
    }
}

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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
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.31.3 94 4/15/2024
2.31.0 76 4/15/2024
2.30.9 152 3/27/2024
2.30.5 83 3/26/2024
2.30.3 84 3/26/2024
2.29.32 78 3/26/2024
2.29.22 150 3/8/2024
2.29.15 89 3/1/2024
2.29.11 66 2/27/2024
2.29.9 82 2/26/2024
2.29.0 65 2/25/2024
2.28.0 102 2/23/2024
2.27.12 61 2/15/2024
2.27.9 61 2/14/2024
2.27.3 82 2/8/2024
2.27.0 57 2/8/2024
2.26.8 59 2/4/2024
2.26.0 61 1/29/2024
2.25.0 61 1/28/2024
2.24.9 65 1/25/2024
2.24.4 56 1/25/2024
2.24.1 67 1/22/2024
2.22.0 57 1/18/2024
2.21.12 56 1/18/2024
2.21.9 69 1/18/2024
2.21.4 80 1/13/2024
2.21.0 67 1/12/2024
2.20.2 100 1/11/2024
2.19.2 118 12/27/2023
2.19.0 86 12/26/2023
2.18.8 75 12/26/2023
2.18.0 88 12/24/2023
2.17.25 91 12/22/2023
2.17.20 96 12/5/2023
2.17.0 75 11/24/2023
2.16.2 64 11/23/2023
2.16.0 66 11/23/2023
2.15.24 65 11/22/2023
2.15.21 61 11/22/2023
2.15.17 65 11/20/2023
2.15.3 67 11/9/2023
2.15.0 47 11/8/2023
2.14.9 71 11/6/2023
2.14.7 66 11/6/2023
2.14.1 76 11/6/2023
2.13.63 78 10/29/2023
2.13.47 70 10/20/2023
2.13.8 90 10/13/2023
2.13.5 78 10/13/2023
2.12.15 73 10/10/2023
2.12.11 72 10/10/2023
2.12.5 87 10/6/2023
2.12.1 76 10/4/2023
2.11.12 77 10/1/2023
2.11.11 73 9/30/2023
2.11.9 76 9/30/2023
2.11.4 73 9/30/2023
2.11.0 79 9/29/2023
2.10.6 70 9/29/2023
2.10.0 73 9/28/2023
2.9.0 68 9/28/2023
2.8.23 68 9/26/2023
2.8.12 78 9/24/2023
2.8.4 70 9/24/2023
2.8.0 72 9/24/2023
2.7.10 70 9/23/2023
2.7.6 73 9/22/2023
2.6.0 78 9/19/2023
2.5.11 75 9/16/2023
2.5.5 93 9/14/2023
2.5.2 96 9/14/2023
2.5.0 72 9/14/2023
2.4.0 87 9/12/2023
2.3.2 89 9/11/2023
2.3.0 83 9/11/2023
2.2.0 86 9/11/2023
2.0.8 89 9/7/2023
2.0.5 80 9/6/2023
2.0.0 84 9/6/2023
1.9.38 84 9/5/2023
1.9.36 68 9/5/2023
1.9.35 83 9/4/2023
1.9.31 81 9/4/2023
1.9.28 86 9/4/2023
1.9.22 83 9/3/2023
1.9.17 84 9/3/2023
1.9.15 82 9/3/2023
1.9.8 96 9/1/2023
1.9.6 89 9/1/2023
1.9.4 92 9/1/2023
1.9.1 98 8/31/2023
1.8.22 107 8/29/2023
1.8.18 101 8/29/2023
1.8.8 96 8/24/2023
1.8.6 93 8/24/2023
1.7.0 89 8/22/2023
1.6.3 94 8/17/2023
1.6.2 93 8/17/2023
1.6.1 93 8/17/2023
1.6.0 96 8/17/2023
1.5.5 100 8/15/2023
1.5.0 94 8/14/2023
1.4.34 103 8/11/2023
1.4.33 106 8/11/2023
1.4.31 104 8/11/2023
1.4.29 99 8/10/2023
1.4.22 106 8/10/2023
1.4.21 114 8/10/2023
1.4.20 103 8/10/2023
1.4.18 108 8/7/2023
1.4.17 106 8/7/2023
1.4.15 106 8/7/2023
1.4.14 121 8/2/2023
1.4.12 110 8/2/2023