Sharpliner

This repository contains tooling that allows YAML pipeline definition in C#. You can use Sharpliner to define Azure DevOps pipelines and GitHub actions in a type-safe comfortable environment of the C# languageyou know to get intellisense and avoid syntax errors and bugs.

Getting started

All you have to do is reference our NuGet package in your project, override a class and build the project! Dead simple!

For more detailed steps, check our documentation:

• Azure DevOps pipelines
• GitHub actions

You can also read about some of our features and reasons to use Sharpliner for your project.

Example

PullRequestPipeline.cs

class PullRequestPipeline : AzureDevopsPipelineDefinition
{
    public override string TargetFile => "azure-pipelines.yml";

    public override TargetPathType TargetPathType => TargetPathType.RelativeToGitRoot;

    public override AzureDevOpsPipeline Pipeline => new()
    {
        Pr = new PrTrigger("main"),

        Variables =
        {
            If.Equal(variables["Build.SourceBranch"], "refs/heads/net-6.0")
                .Variable("DotnetVersion", "6.0.100"),

            If.NotEqual(variables["Build.SourceBranch"], "refs/heads/net-6.0")
                .Variable("DotnetVersion", "5.0.202"),
        },

        Jobs =
        {
            new Job("Build", "Build and test")
            {
                Pool = new HostedPool("Azure Pipelines", "windows-latest"),
                Steps =
                {
                    Task("UseDotNet@2", "Install .NET SDK") with
                    {
                        Inputs = new()
                        {
                            { "packageType", "sdk" },
                            { "version", "$(DotnetVersion)" },
                        }
                    },

                    Task("DotNetCoreCLI@2", "Build and test") with
                    {
                        Inputs = new()
                        {
                            { "command", "test" },
                            { "projects", "src/MyProject.sln" },
                        }
                    },
                }
            }
        },
    }
}

Sharpliner features

Apart from the obvious benefits of using static type language with IDE support, not having to have to deal with indentation problems ever again or the ability to generate YAML programatically, there are several other upsides to Sharpliner.

Pipeline validation

Your pipeline definition can be validated during publishing and you can uncover issues, such as invalid properties or just syntax errors, you would only find by trying to run the pipeline in CI. This gives you a faster dev loop and greater productivity.

Sourcing scripts from files

When you need to add cmd, PowerShell or bash steps into your pipeline, mainatining these bits inside YAML can be error prone. With Sharpliner you can keep scripts in their own files (.ps1, .sh..) where you get the natural environment you're used to such as syntax highlighting. Sharpliner gives you APIs to load these on build time and include them inline:

Steps =
{
    Bash.FromResourceFile("embedded-script.sh") with
    {
        DisplayName = "Run post-build clean-up",
        Timeout = TimeSpan.FromMinutes(5),
    }
}

Something missing?

This project is still under development and we probably don't cover 100% of the cases. If you find a missing feature / API / property, file an issue in this repository, or even better, file a PR and we will work with you to get you going.

Contribute

TODO