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 {
	// "url" specifies the default stash url in case of Bitbucket enterprise
	URL string `yaml:",omitempty" jsonschema:"required"`
	// "username" specifies the username used to authenticate with Bitbucket API
	Username string `yaml:",omitempty"`
	//  "token" specifies the credential used to authenticate with Stash API
	//
	//  remark:
	//    A token is a sensitive information, it's recommended to not set this value directly in the configuration file
	//    but to use an environment variable or a SOPS file.
	//
	//    The value can be set to `{{ requiredEnv "GITEA_TOKEN"}}` to retrieve the token from the environment variable `GITHUB_TOKEN`
	//	  or `{{ .gitea.token }}` to retrieve the token from a SOPS file.
	//
	//	  For more information, about a SOPS file, please refer to the following documentation:
	//    https://github.com/getsops/sops
	Token string `yaml:",omitempty"`
	//  "password" specifies the credential used to authenticate with Stash API, it must be combined with "username"
	//
	//  remark:
	//    A token is a sensitive information, it's recommended to not set this value directly in the configuration file
	//    but to use an environment variable or a SOPS file.
	//
	//    The value can be set to `{{ requiredEnv "GITEA_TOKEN"}}` to retrieve the token from the environment variable `GITHUB_TOKEN`
	//	  or `{{ .gitea.token }}` to retrieve the token from a SOPS file.
	//
	//	  For more information, about a SOPS file, please refer to the following documentation:
	//    https://github.com/getsops/sops
	Password string `yaml:",omitempty"`
	// "owner" defines repository owner
	Owner string `yaml:",omitempty" jsonschema:"required"`
	// "repository" defines 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