Go

Learn how the find the documentation for the Go sdk

Overview

Vela Go SDK is a client to perform operations on Vela objects or view content in a new way to integrate into applications.

For a complete list of APIs and examples, please take a look at the Godoc Reference documentation.

Minimum requirements

Go 1.13 or above

Get build info example

Below is a sample Go program demonstrating how to authenticate and get a build with the Go SDK:

package main

import (
    "fmt"
    "github.com/go-vela/sdk-go/vela"
)

func main() {
    // full URI to the Vela server
    url := "https://your-vela-server.example.com"

    token := "someToken"
    accessToken := "someAccessToken"
    refreshToken := "someRefreshToken"   

    // instantiate a new Vela client
    client, err := vela.NewClient(url, nil)
    if err != nil {
        fmt.Println(err)
    }    

    // set the Authentication mechanisms for the client
    client.Authentication.SetTokenAuth(token)
    client.Authentication.SetAccessAndRefreshAuth(accessToken, refreshToken) 
    
    // Get a build from the server
    build, resp, err := c.Build.Get("go-vela", "sdk-go", 1)
    if err != nil {
        fmt.Println(err)
    }

    fmt.Printf("Received response code %d, for build %+v", resp.StatusCode, build)    
}

Last modified January 14, 2021: refactor(sdk): update available sdk clients (#195) (c00fe16d)