Skip to content

RedHatInsights/event-schemas-go

Repository files navigation

console.redhat.com CloudEvents for Go

This repo contains Go bindings of the JSON schema definitions for events generated by console.redhat.com

Getting started

To install run:

$ go get -u github.com/RedHatInsights/event-schemas-go

Layout

  • api: Defines a submodule with the current version of console.redhat.com CloudEvents.
  • examples: Contains examples on how to use this library.
  • apps and core: Go bindings for console.redhat.com cloud events.

Generating code

The generate.js script generates the Go code.

This script is executed on any push to our main branch, ensuring it never goes out of sync.

Releasing a new version

The release process works with release-please-action. You can head to their documentation to learn more about it, but in a nutshell:

  • Uses Conventional Commits
  • Creates a PR when there is something to be released (patch, minor or major). Once that PR is merged, a new release occurs.

GoDoc

Docs are automatically generated and hosted on GoDoc: https://pkg.go.dev/github.com/RedHatInsights/event-schemas-go.