README
¶
Keptn go-utils
This repo serves as a util package for common functionalities such as logging of the Keptn Project.
Please post any issues with this package to the keptn/keptn repository and label them with area:go-utils.
Installation
Get the latest version using
go get github.com/keptn/go-utils
Also consider browsing our Releases Page to find out about all releases.
Contributing
If you want to contribute, just create a PR on the master branch.
Please also see CONTRIBUTING.md instructions on how to contribute.
Usage
Below we have listed some basic examples. You can find more information about the usage within the docs/ folder.
Utils
If you need to access several utility functions:
import {
keptnutils "github.com/keptn/go-utils/pkg/utils"
}
Logging Example:
keptnutils.Debug(keptncontext, message)
keptnutils.Info(keptncontext, message)
keptnutils.Error(keptncontext, message)
CloudEvent Data
If you need to access data within CloudEvents:
import {
keptnevents "github.com/keptn/go-utils/pkg/events"
)
Example:
func parseCloudEvent(event cloudevents.Event) (keptnevents.TestFinishedEventData, error) {
eventData := &keptnevents.TestsFinishedEventData{}
err := event.DataAs(eventData)
return eventData, err
}
Models
If you need to access Models for YAML files:
import {
keptnmodels "github.com/keptn/go-utils/pkg/models"
)
Automation
Within .travis.yml we have included an automation that creates a Pull Request to
github.com/keptn/keptn to update go.mod files with an updated version of this
package (based on the commit hash). To make this work, a GITHUB_TOKEN (personal access token)
needs to be added within the travis-ci settings page.
Directories