{"id":31821378,"url":"https://github.com/serverlessworkflow/sdk-go","last_synced_at":"2025-10-11T13:24:12.704Z","repository":{"id":41997577,"uuid":"279683040","full_name":"serverlessworkflow/sdk-go","owner":"serverlessworkflow","description":"Go SDK for Serverless Workflow","archived":false,"fork":false,"pushed_at":"2025-05-09T14:01:59.000Z","size":661,"stargazers_count":100,"open_issues_count":6,"forks_count":45,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-08-09T21:48:45.818Z","etag":null,"topics":["cncf","go","kubernetes","sdk","serverless","serverless-workflow"],"latest_commit_sha":null,"homepage":"http://serverlessworkflow.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverlessworkflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-14T20:09:24.000Z","updated_at":"2025-07-15T14:54:25.000Z","dependencies_parsed_at":"2023-10-10T20:40:03.946Z","dependency_job_id":"19bf7b9e-ae92-453a-9d2b-3b7a0cbb406c","html_url":"https://github.com/serverlessworkflow/sdk-go","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/serverlessworkflow/sdk-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverlessworkflow%2Fsdk-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverlessworkflow%2Fsdk-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverlessworkflow%2Fsdk-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverlessworkflow%2Fsdk-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverlessworkflow","download_url":"https://codeload.github.com/serverlessworkflow/sdk-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverlessworkflow%2Fsdk-go/sbom","scorecard":{"id":812968,"data":{"date":"2025-08-11","repo":{"name":"github.com/serverlessworkflow/sdk-go","commit":"592f31d64f24a3afd4d10040ae5a488f9600158b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.7,"checks":[{"name":"Code-Review","score":6,"reason":"Found 18/27 approved changesets -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":10,"reason":"GitHub workflow tokens follow principle of least privilege","details":["Info: topLevel 'contents' permission set to 'read': .github/workflows/Go-SDK-PR-Check.yaml:29","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:96: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:107: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:123: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/Go-SDK-PR-Check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yaml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/serverlessworkflow/sdk-go/stale.yaml/main?enable=pin","Warn: goCommand not pinned by hash: .github/workflows/Go-SDK-PR-Check.yaml:91","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 goCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":1,"reason":"SAST tool is not run on all commits -- score normalized to 1","details":["Warn: 4 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T13:35:43.138Z","repository_id":41997577,"created_at":"2025-08-23T13:35:43.138Z","updated_at":"2025-08-23T13:35:43.138Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279007325,"owners_count":26084280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cncf","go","kubernetes","sdk","serverless","serverless-workflow"],"created_at":"2025-10-11T13:24:11.664Z","updated_at":"2025-10-11T13:24:12.699Z","avatar_url":"https://github.com/serverlessworkflow.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Go SDK for Serverless Workflow\n\nThe Go SDK for Serverless Workflow provides strongly-typed structures for the [Serverless Workflow specification](https://github.com/serverlessworkflow/specification/blob/v1.0.0/schema/workflow.yaml). It simplifies parsing, validating, and interacting with workflows in Go. Starting from version `v3.1.0`, the SDK also includes a partial reference implementation, allowing users to execute workflows directly within their Go applications.\n\n---\n\n## Table of Contents\n\n- [Status](#status)\n- [Releases](#releases)\n- [Getting Started](#getting-started)\n  - [Installation](#installation)\n  - [Basic Usage](#basic-usage)\n  - [Parsing Workflow Files](#parsing-workflow-files)\n  - [Programmatic Workflow Creation](#programmatic-workflow-creation)\n- [Reference Implementation](#reference-implementation)\n  - [Example: Running a Workflow](#example-running-a-workflow)\n- [Slack Community](#slack-community)\n- [Contributing](#contributing)\n  - [Code Style](#code-style)\n  - [EditorConfig](#editorconfig)\n  - [Known Issues](#known-issues)\n\n---\n\n## Status\n\nThis table indicates the current state of implementation of various SDK features:\n\n| Feature                                     | Status              |\n|-------------------------------------------- |---------------------|\n| Parse workflow JSON and YAML definitions    | :heavy_check_mark:  |\n| Programmatically build workflow definitions | :heavy_check_mark:  |\n| Validate workflow definitions (Schema)      | :heavy_check_mark:  |\n| Specification Implementation                | :heavy_check_mark:* |\n| Validate workflow definitions (Integrity)   | :no_entry_sign:     |\n| Generate workflow diagram (SVG)             | :no_entry_sign:     |\n\n\u003e **Note**: *Implementation is partial; contributions are encouraged.\n\n---\n\n## Releases\n\n|                              Latest Releases                               |                            Conformance to Spec Version                            |\n|:--------------------------------------------------------------------------:|:---------------------------------------------------------------------------------:|\n| [v1.0.0](https://github.com/serverlessworkflow/sdk-go/releases/tag/v1.0.0) |      [v0.5](https://github.com/serverlessworkflow/specification/tree/0.5.x)       |\n| [v2.0.1](https://github.com/serverlessworkflow/sdk-go/releases/tag/v2.0.1) |      [v0.6](https://github.com/serverlessworkflow/specification/tree/0.6.x)       |\n| [v2.1.2](https://github.com/serverlessworkflow/sdk-go/releases/tag/v2.1.2) |      [v0.7](https://github.com/serverlessworkflow/specification/tree/0.7.x)       |\n| [v2.5.0](https://github.com/serverlessworkflow/sdk-go/releases/tag/v2.5.0) |      [v0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x)       |\n| [v3.1.0](https://github.com/serverlessworkflow/sdk-go/releases/tag/v3.1.0) | [v1.0.0](https://github.com/serverlessworkflow/specification/releases/tag/v1.0.0) |\n\n---\n\n## Reference Implementation\n\nThe SDK provides a partial reference runner to execute your workflows:\n\n### Example: Running a Workflow\n\nBelow is a simple YAML workflow that sets a message and then prints it:\n\n```yaml\ndocument:\n  dsl: \"1.0.0\"\n  namespace: \"examples\"\n  name: \"simple-workflow\"\n  version: \"1.0.0\"\ndo:\n  - set:\n      message: \"Hello from the Serverless Workflow SDK in Go!\"\n```\n\nYou can execute this workflow using the following Go program:\n\nExample of executing a workflow defined in YAML:\n\n```go\npackage main\n\nimport (\n    \"fmt\"\n    \"os\"\n    \"path/filepath\"\n\n    \"github.com/serverlessworkflow/sdk-go/v3/impl\"\n    \"github.com/serverlessworkflow/sdk-go/v3/parser\"\n)\n\nfunc RunWorkflow(workflowFilePath string, input map[string]interface{}) (interface{}, error) {\n    data, err := os.ReadFile(filepath.Clean(workflowFilePath))\n    if err != nil {\n        return nil, err\n    }\n    workflow, err := parser.FromYAMLSource(data)\n    if err != nil {\n        return nil, err\n    }\n\n    runner := impl.NewDefaultRunner(workflow)\n    output, err := runner.Run(input)\n    if err != nil {\n        return nil, err\n    }\n    return output, nil\n}\n\nfunc main() {\n    output, err := RunWorkflow(\"./myworkflow.yaml\", map[string]interface{}{\"shouldCall\": true})\n    if err != nil {\n        panic(err)\n    }\n    fmt.Printf(\"Workflow completed with output: %v\\n\", output)\n}\n```\n\n### Implementation Roadmap\n\nThe table below lists the current state of this implementation. This table is a roadmap for the project based on the [DSL Reference doc](https://github.com/serverlessworkflow/specification/blob/v1.0.0/dsl-reference.md).\n\n| Feature | State |\n| ----------- | --------------- |\n| Workflow Document | ✅  |\n| Workflow Use | 🟡 |\n| Workflow Schedule | ❌ | \n| Task Call | ❌ |\n| Task Do | ✅ |\n| Task Emit | ❌ | \n| Task For | ✅ |\n| Task Fork | ✅ | \n| Task Listen | ❌ | \n| Task Raise | ✅ |\n| Task Run | ❌ |\n| Task Set | ✅ | \n| Task Switch | ✅ | \n| Task Try | ❌ | \n| Task Wait | ❌ |\n| Lifecycle Events | 🟡 |\n| External Resource | ❌ |\n| Authentication | ❌ |\n| Catalog | ❌ |\n| Extension | ❌ |\n| Error | ✅ | \n| Event Consumption Strategies | ❌ | \n| Retry | ❌ |\n| Input | ✅ |\n| Output | ✅ |\n| Export | ✅ |\n| Timeout | ❌ |\n| Duration | ❌ |\n| Endpoint | ✅ |\n| HTTP Response | ❌ |\n| HTTP Request | ❌ |\n| URI Template | ✅ | \n| Container Lifetime | ❌ |\n| Process Result | ❌ |\n| AsyncAPI Server | ❌ |\n| AsyncAPI Outbound Message | ❌ |\n| AsyncAPI Subscription | ❌ |\n| Workflow Definition Reference | ✅ |\n| Subscription Iterator | ❌ |\n\nWe 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.\n\nIf you are willing to help, please [file a sub-task](https://github.com/serverlessworkflow/sdk-go/issues/221) in this EPIC describing what you are planning to work on first.\n\n---\n\n## Slack Community\n\nJoin our community on the CNCF Slack to collaborate, ask questions, and contribute:\n\n[CNCF Slack Invite](https://communityinviter.com/apps/cloud-native/cncf)\n\nFind us in the `#serverless-workflow-sdk` channel.\n\n---\n\n## Contributing\n\nYour contributions are very welcome!\n\n### Code Style\n\n- Format imports with `goimports`.\n- Run static analysis using:\n\n```shell\nmake lint\n```\n\nAutomatically fix lint issues:\n\n```shell\nmake lint params=--fix\n```\n\n### EditorConfig\n\nA sample `.editorconfig` for IntelliJ or GoLand users can be found [here](contrib/intellij.editorconfig).\n\n### Known Issues\n\n- **MacOS Issue**: If you encounter `goimports: can't extract issues from gofmt diff output`, resolve it with:\n\n```shell\nbrew install diffutils\n```\n\n---\n\nContributions are greatly appreciated! Check [this EPIC](https://github.com/serverlessworkflow/sdk-go/issues/221) and contribute to completing more features.\n\nHappy coding!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverlessworkflow%2Fsdk-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverlessworkflow%2Fsdk-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverlessworkflow%2Fsdk-go/lists"}