https://github.com/temporalio/sdk-go
Temporal Go SDK
https://github.com/temporalio/sdk-go
golang open-source sdk-go service-bus workflow-automation workflow-engine workflow-management-system
Last synced: 5 days ago
JSON representation
Temporal Go SDK
- Host: GitHub
- URL: https://github.com/temporalio/sdk-go
- Owner: temporalio
- License: mit
- Created: 2019-10-17T16:34:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-09T14:23:22.000Z (6 days ago)
- Last Synced: 2025-04-09T15:36:47.923Z (6 days ago)
- Topics: golang, open-source, sdk-go, service-bus, workflow-automation, workflow-engine, workflow-management-system
- Language: Go
- Homepage: https://docs.temporal.io/application-development?lang=go
- Size: 15.2 MB
- Stars: 605
- Watchers: 18
- Forks: 233
- Open Issues: 201
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-go - Temporal - Durable execution system for making code fault-tolerant and simple. (Distributed Systems / Search and Analytic Databases)
- awesome-temporal - Go SDK
- awesome-repositories - temporalio/sdk-go - Temporal Go SDK (Go)
README
# Temporal Go SDK [](https://github.com/temporalio/sdk-go/actions/workflows/ci.yml) [](https://pkg.go.dev/go.temporal.io/sdk)
[Temporal](https://github.com/temporalio/temporal) is a distributed, scalable, durable, and highly available orchestration engine used to execute asynchronous long-running business logic in a scalable and resilient way.
"Temporal Go SDK" is the framework for authoring workflows and activities using Go language.
## How to use
Clone this repo into the preferred location.
```bash
git clone https://github.com/temporalio/sdk-go.git
```
See [samples](https://github.com/temporalio/samples-go) to get started.
Documentation is available [here](https://docs.temporal.io).
You can also find the API documentation [here](https://pkg.go.dev/go.temporal.io/sdk).
## Using slog
If using Go version 1.21+ the Go SDK provides built in integration with the standard [slog](https://pkg.go.dev/log) package.
```go
package main
import (
"log/slog"
"os"
"go.temporal.io/sdk/client"
"go.temporal.io/sdk/log"
"go.temporal.io/sdk/worker"
)
func main() {
clientOptions := client.Options{
Logger: log.NewStructuredLogger(
slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
AddSource: true,
Level: slog.LevelDebug,
}))),
}
temporalClient, err := client.Dial(clientOptions)
// ...
}
```
## Workflow determinism checker
See [contrib/tools/workflowcheck](contrib/tools/workflowcheck) for a tool to detect non-determinism in Workflow Definitions.
## Contributing
We'd love your help in making the Temporal Go SDK great. Please review our [contribution guidelines](CONTRIBUTING.md).
## Go SDK upgrading past v1.25.1
Go SDK version v1.26.0 switched from using https://github.com/gogo/protobuf to https://github.com/golang/protobuf. While this migration is mostly internal there are a few user visible changes to be aware of:
### Change in types
* `time.Time` in proto structs will now be [timestamppb.Timestamp](https://pkg.go.dev/google.golang.org/[email protected]/types/known/timestamppb#section-documentation)
* `time.Duration` will now be [durationpb.Duration](https://pkg.go.dev/google.golang.org/protobuf/types/known/durationpb)
* V2-generated structs embed locks, so you cannot dereference them.
### Incompatible proto/json encoding
Proto enums will, when formatted to JSON, now be in SCREAMING_SNAKE_CASE rather than PascalCase.
* If trying to deserialize old JSON with PascalCase to proto use [go.temporal.io/api/temporalproto](https://pkg.go.dev/go.temporal.io/api/temporalproto).
If users used Temporal proto types in their Workflows, such as for activity output, users may need to modify the default data converter to handle these payloads.
``` go
converter.NewProtoJSONPayloadConverterWithOptions(converter.ProtoJSONPayloadConverterOptions{
LegacyTemporalProtoCompat: true,
}),
```
While upgrading from Go SDK version `< 1.26.0` to a version `>= 1.26.0` users may want to also bias towards using
proto binary to avoid any potential incompatibilities due to having clients serialize messages with incompatible `proto/json` format.
On clients running Go SDK `< 1.26.0`
``` go
converter.NewCompositeDataConverter(
converter.NewNilPayloadConverter(),
converter.NewByteSlicePayloadConverter(),
converter.NewProtoPayloadConverter(),
converter.NewProtoJSONPayloadConverterWithOptions(),
converter.NewJSONPayloadConverter(),
)
```
On clients running Go SDK `>= 1.26.0`
``` go
converter.NewCompositeDataConverter(
converter.NewNilPayloadConverter(),
converter.NewByteSlicePayloadConverter(),
converter.NewProtoPayloadConverter(),
converter.NewProtoJSONPayloadConverterWithOptions(converter.ProtoJSONPayloadConverterOptions{
LegacyTemporalProtoCompat: true,
}),
converter.NewJSONPayloadConverter(),
)
```
Note: Payloads encoded with `proto/binary` will not be readable in the Temporal web UI.
## License
MIT License, please see [LICENSE](LICENSE) for details.