Repository files navigation

The Go SDK for Serverless Workflow provides strongly-typed structures for theServerless Workflow specification. It simplifies parsing, validating, and interacting with workflows in Go. Starting from versionv3.1.0, the SDK also includes a partial reference implementation, allowing users to execute workflows directly within their Go applications.

• Status
• Releases
• Getting Started
  • Installation
  • Basic Usage
  • Parsing Workflow Files
  • Programmatic Workflow Creation
• Reference Implementation
  • Example: Running a Workflow
• Slack Community
• Contributing
  • Code Style
  • EditorConfig
  • Known Issues

This table indicates the current state of implementation of various SDK features:

Note: *Implementation is partial; contributions are encouraged.

The SDK provides a partial reference runner to execute your workflows:

Below is a simple YAML workflow that sets a message and then prints it:

document:dsl:"1.0.0"namespace:"examples"name:"simple-workflow"version:"1.0.0"do:  -set:message:"Hello from the Serverless Workflow SDK in Go!"

You can execute this workflow using the following Go program:

Example of executing a workflow defined in YAML:

package mainimport ("fmt""os""path/filepath""github.com/serverlessworkflow/sdk-go/v3/impl""github.com/serverlessworkflow/sdk-go/v3/parser")funcRunWorkflow(workflowFilePathstring,inputmap[string]interface{}) (interface{},error) {data,err:=os.ReadFile(filepath.Clean(workflowFilePath))iferr!=nil {returnnil,err    }workflow,err:=parser.FromYAMLSource(data)iferr!=nil {returnnil,err    }runner:=impl.NewDefaultRunner(workflow)output,err:=runner.Run(input)iferr!=nil {returnnil,err    }returnoutput,nil}funcmain() {output,err:=RunWorkflow("./myworkflow.yaml",map[string]interface{}{"shouldCall":true})iferr!=nil {panic(err)    }fmt.Printf("Workflow completed with output: %v\n",output)}

The table below lists the current state of this implementation. This table is a roadmap for the project based on theDSL Reference doc.

We love contributions! Our aim is to have a complete implementation to serve as a reference or to become a project on its own to favor the CNCF Ecosystem.

If you are willing to help, pleasefile a sub-task in this EPIC describing what you are planning to work on first.

Join our community on the CNCF Slack to collaborate, ask questions, and contribute:

CNCF Slack Invite

Find us in the#serverless-workflow-sdk channel.

Your contributions are very welcome!

• Format imports withgoimports.
• Run static analysis using:

make lint

Automatically fix lint issues:

make lint params=--fix

A sample.editorconfig for IntelliJ or GoLand users can be foundhere.

• MacOS Issue: If you encountergoimports: can't extract issues from gofmt diff output, resolve it with:

brew install diffutils

Contributions are greatly appreciated! Checkthis EPIC and contribute to completing more features.

Happy coding!