sdk-go

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #golang #go #android #macos #java #windows #cli #kubernetes #awesome-list #security

(★ 17)

Go SDK for CDEvents

sdk-go Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Golang CDEvents SDK

[![Plumber Score](https://score.getplumber.io/github.com/cdevents/sdk-go.svg)](https://score.getplumber.io/github.com/cdevents/sdk-go)

Golang SDK to emit [CDEvents](https://cdevents.dev).

The SDK can be used to create CDEvents and send them as CloudEvents, as well as parse a received CloudEvent into a CDEvent.

## Get started

Add the module as dependency using go mod:

```golang
go get github.com/cdevents/sdk-go
```

And import the module in your code corresponding to the desired version of the specification.
For CDEvents v0.5.x (latest), use:

```golang
import cdeventsv05 "github.com/cdevents/sdk-go/pkg/api/v05"
```

For CDEvents v0.4.x, use:

```golang
import cdeventsv04 "github.com/cdevents/sdk-go/pkg/api/v04"
```

## Create your first CDEvent

To create a CDEvent, for instance a [*pipelineRun queued*](https://cdevents.dev/docs/core/#pipelinerun-queued) one:

```golang
func main() {

// Create the base event
    event, err := cdeventsv05.NewPipelineRunQueuedEvent()
    if err != nil {
      log.Fatalf("could not create a cdevent, %v", err)
    }

// Set the required context fields
    event.SetSubjectId("myPipelineRun1")
    event.SetSource("my/first/cdevent/program")

// Set the required subject fields
    event.SetSubjectPipelineName("myPipeline")
    event.SetSubjectUrl("https://example.com/myPipeline")
}
```

## Send your first CDEvent as CloudEvent

Import the modules in your code

```golang
import cdevents "github.com/cdevents/sdk-go/pkg/api"
import cloudevents "github.com/cloudevents/sdk-go/v2"
```

To send a CDEvent as CloudEvent:

```golang
func main() {
    // (...) set the event first
    ce, err := cdevents.AsCloudEvent(event)

// Set send options
    ctx := cloudevents.ContextWithTarget(context.Background(), "http://localhost:8080/")
    ctx = cloudevents.WithEncodingBinary(ctx)

c, err := cloudevents.NewClientHTTP()
    if err != nil {
        log.Fatalf("failed to create client, %v", err)
    }

// Send the CloudEvent
    // c is a CloudEvent client
    if result := c.Send(ctx, *ce); cloudevents.IsUndelivered(result) {
        log.Fatalf("failed to send, %v", result)
    }
}
```

See the [CloudEvents](https://github.com/cloudevents/sdk-go#send-your-first-cloudevent) docs as well.

## Documentation

More examples are available in the [docs](./docs) folder.
Online API Reference:
- [SDK Root](https://pkg.go.dev/github.com/cdevents/sdk-go/pkg/api)
- [v05 Specific](https://pkg.go.dev/github.com/cdevents/sdk-go/pkg/api/v05)
- [v04 Specific](https://pkg.go.dev/github.com/cdevents/sdk-go/pkg/api/v04)
- [v03 Specific](https://pkg.go.dev/github.com/cdevents/sdk-go/pkg/api/v03)

## Contributing

If you would like to contribute, see our [development](DEVELOPMENT.md) guide.

## References

- [CDEvents](https://cdevents.dev)

sdk-go

sdk-go Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

sdk-go

sdk-go Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README