udash

Documentation

Index

• Variables
• func ConfigFilePath() (string, error)
• func IsConfigFile() (string, bool)
• func Login(serviceURL, clientID, issuer, audience, accessToken string) error
• func Logout(url string) error
• func Publish(r *reports.Report) error
• func Token(audience string) (URL string, ApiURL string, Token string, err error)

Variables

var (
	// DefaultEnvVariableAPIURL defines the default environment variable used to retrieve API url
	DefaultEnvVariableAPIURL string = "UPDATECLI_UDASH_API_URL"
	// DefaultEnvVariableAccessToken defines the default environment variable used to retrieve API access token
	DefaultEnvVariableAccessToken string = "UPDATECLI_UDASH_ACCESS_TOKEN" // #nosec G101
	// DefaultEnvVariableURL defines the default environment variable used to retrieve url
	DefaultEnvVariableURL string = "UPDATECLI_UDASH_URL"
)

var (
	Audience string
)

var (
	// ErrNoUdashAPIURL is returned if we couldn't find an Updatecli report API
	ErrNoUdashAPIURL error = fmt.Errorf("no Updatecli API defined")
)

Functions

func ConfigFilePath

func ConfigFilePath() (string, error)

ConfigFilePath returns the path of the config file

func IsConfigFile

func IsConfigFile() (string, bool)

IsConfigFile checks if the udash config file exists

func Login

func Login(serviceURL, clientID, issuer, audience, accessToken string) error

Login will open a browser to authenticate a user and retrieve an access token

func Logout

func Logout(url string) error

Logout remove a token from the local updatecli configuration file

func Publish

func Publish(r *reports.Report) error

Publish publish a pipeline report to the updatecli api

func Token

func Token(audience string) (URL string, ApiURL string, Token string, err error)

Token return the token for a specific auth domain