client

Documentation

Index

• type Client
  • func New(s Spec) (Client, error)
• type Spec
  • func (s *Spec) Sanitize() error
  • func (s Spec) Validate() error

Types

type Client

type Client *scm.Client

func New

func New(s Spec) (Client, error)

type Spec

type Spec struct {
	// [S][C][T] URL specifies the default github url in case of Bitbucket enterprise
	URL string `yaml:",omitempty" jsonschema:"required"`
	// [S][C][T] Username specifies the username used to authenticate with Bitbucket API
	Username string `yaml:",omitempty"`
	// [S][C][T] Token specifies the credential used to authenticate with
	Token string `yaml:",omitempty"`
	// [S][C][T] Token specifies the credential used to authenticate with
	Password string `yaml:",omitempty"`
	// Owner specifies repository owner
	Owner string `yaml:",omitempty" jsonschema:"required"`
	// Repository specifies the name of a repository for a specific owner
	Repository string `yaml:",omitempty" jsonschema:"required"`
}

Spec defines a specification for a "bitbucket" resource parsed from an updatecli manifest file

func (*Spec) Sanitize

func (s *Spec) Sanitize() error

Sanitize parse and update if needed a spec content

func (Spec) Validate

func (s Spec) Validate() error

Validate validates that a spec contains good content