ServerlessWorkflow.Sdk.IO 1.0.0-alpha1

This is a prerelease version of ServerlessWorkflow.Sdk.IO.

dotnet add package ServerlessWorkflow.Sdk.IO --version 1.0.0-alpha1

NuGet\Install-Package ServerlessWorkflow.Sdk.IO -Version 1.0.0-alpha1

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="ServerlessWorkflow.Sdk.IO" Version="1.0.0-alpha1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add ServerlessWorkflow.Sdk.IO --version 1.0.0-alpha1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ServerlessWorkflow.Sdk.IO, 1.0.0-alpha1"

#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 ServerlessWorkflow.Sdk.IO as a Cake Addin
#addin nuget:?package=ServerlessWorkflow.Sdk.IO&version=1.0.0-alpha1&prerelease

// Install ServerlessWorkflow.Sdk.IO as a Cake Tool
#tool nuget:?package=ServerlessWorkflow.Sdk.IO&version=1.0.0-alpha1&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Serverless Workflow .NET SDK

The official .NET SDK for the Serverless Workflow DSL.

The SDK is composed of three Nuget packages:

Core, which contains the models of the Serverless Workflow DSL
Builders, which contains service used to build workflow definitions programmatically
IO, which contains the services used to read and write workflow definitions

Installation

Core:

dotnet add package ServerlessWorkflow.Sdk

Builders:

dotnet add package ServerlessWorkflow.Sdk.Builders

IO:

dotnet add package ServerlessWorkflow.Sdk.IO

Example usage

Building a workflow definition programmatically:

var definition = new WorkflowDefinitionBuilder()
    .WithName("fake-workflow")
    .WithVersion("0.1.0:fake")
    .Do("todo-1", task => task
        .Call("http")
        .With("method", "get")
        .With("uri", "https://fake-api.com"))
    .Build();

Reading and writing a workflow definition:

using var inputStream = File.OpenRead("workflow.yaml");
var reader = WorkflowDefinitionReader.Create();
var workflow = await reader.ReadAsync(inputStream);

using var outputStream = File.Create("workflow.yaml");
var writer = WorkflowDefinitionWriter.Create();
await writer.WriteAsync(workflow, stream, WorkflowDefinitionFormat.Yaml);

Product	Compatible and additional computed target framework versions.
.NET	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.