BarakoCMS.Workflow.SDK 3.0.0-beta.1

BarakoCMS Workflow SDK

Build custom workflow actions for BarakoCMS without modifying core code.

Installation

dotnet add package BarakoCMS.Workflow.SDK --version 3.0.0-beta.1

Quick Start

1. Create a Custom Action

using BarakoCMS.Workflow.SDK;
using BarakoCMS.Workflow.SDK.Abstractions;
using BarakoCMS.Workflow.SDK.Attributes;
using BarakoCMS.Workflow.SDK.Models;

[WorkflowActionMetadata(Category = "Notifications", Icon = "📧")]
public class SendEmailAction : WorkflowActionBase
{
    public override string ActionType => "send-email";
    public override string DisplayName => "Send Email";
    public override string Description => "Sends an email notification";

    public override IReadOnlyList<ParameterDefinition> Parameters => new[]
    {
        new ParameterDefinition
        {
            Name = "to",
            DisplayName = "To Address",
            Type = "string",
            Required = true
        },
        new ParameterDefinition
        {
            Name = "subject",
            DisplayName = "Subject",
            Type = "string",
            Required = true
        },
        new ParameterDefinition
        {
            Name = "body",
            DisplayName = "Body",
            Type = "string",
            Required = true
        }
    };

    public override async Task<ActionResult> ExecuteAsync(
        IWorkflowContext context,
        Dictionary<string, object> parameters,
        CancellationToken ct)
    {
        var to = GetParameter<string>(parameters, "to");
        var subject = GetParameter<string>(parameters, "subject");
        var body = GetParameter<string>(parameters, "body");

        context.Logger.LogInformation("Sending email to {To}", to);

        // Your email sending logic here
        await SendEmailAsync(to, subject, body);

        return ActionResult.Succeeded(new Dictionary<string, object>
        {
            ["sent_to"] = to,
            ["sent_at"] = DateTime.UtcNow
        });
    }

    private async Task SendEmailAsync(string to, string subject, string body)
    {
        // Implementation
        await Task.CompletedTask;
    }
}

2. Build and Deploy

dotnet build
dotnet pack

# Copy DLL to BarakoCMS plugins directory
cp bin/Release/net8.0/MyPlugin.dll /path/to/barakocms/plugins/

3. Use in Workflows

Your custom action will appear in the workflow builder automatically!

Features

• Simple API - Inherit from WorkflowActionBase and implement your logic
• Type-Safe Parameters - Built-in parameter validation and type conversion
• Dependency Injection - Access services via IWorkflowContext.GetService<T>()
• Testing Helpers - Easy unit testing with WorkflowActionTestHelper
• Full Documentation - XML docs for all public APIs

Documentation

• API Reference
• Examples
• Testing Guide

Requirements

• .NET 8.0 or later
• BarakoCMS v3.0.0-beta.1 or later

License

MIT

Support

• GitHub Issues
• Discussions