client

Documentation

Overview

Package client contains the client implementations for several providers.

Index

• Constants
• Variables
• func IsNotImplementedErr(err error) bool
• type Client
  • func New(ctx *context.Context) (Client, error)
  • func NewGitHub(ctx *context.Context, token string) (Client, error)
  • func NewGitLab(ctx *context.Context, token string) (Client, error)
  • func NewGitea(ctx *context.Context, token string) (Client, error)
  • func NewWithToken(ctx *context.Context, token string) (Client, error)
• type ErrNoMilestoneFound
  • func (e ErrNoMilestoneFound) Error() string
• type Info
• type NotImplementedError
  • func (e NotImplementedError) Error() string
• type Repo
  • func RepoFromRef(ref config.RepoRef) Repo
  • func (r Repo) String() string
• type RetriableError
  • func (e RetriableError) Error() string

Constants

const DefaultGitHubDownloadURL = "https://github.com"

const DefaultGitLabDownloadURL = "https://gitlab.com"

Variables

var ErrExtractHashFromFileUploadURL = errors.New("could not extract hash from gitlab file upload url")

ErrExtractHashFromFileUploadURL indicates the file upload hash could not ne extracted from the url.

Functions

func IsNotImplementedErr

func IsNotImplementedErr(err error) bool

IsNotImplementedErr returns true if given error is a NotImplementedError.

Types

type Client

type Client interface {
	CloseMilestone(ctx *context.Context, repo Repo, title string) (err error)
	CreateRelease(ctx *context.Context, body string) (releaseID string, err error)
	ReleaseURLTemplate(ctx *context.Context) (string, error)
	CreateFile(ctx *context.Context, commitAuthor config.CommitAuthor, repo Repo, content []byte, path, message string) (err error)
	Upload(ctx *context.Context, releaseID string, artifact *artifact.Artifact, file *os.File) (err error)
}

Client interface.

func New

func New(ctx *context.Context) (Client, error)

New creates a new client depending on the token type.

func NewGitHub

func NewGitHub(ctx *context.Context, token string) (Client, error)

NewGitHub returns a github client implementation.

func NewGitLab

func NewGitLab(ctx *context.Context, token string) (Client, error)

NewGitLab returns a gitlab client implementation.

func NewGitea

func NewGitea(ctx *context.Context, token string) (Client, error)

NewGitea returns a gitea client implementation.

func NewWithToken

func NewWithToken(ctx *context.Context, token string) (Client, error)

type ErrNoMilestoneFound

type ErrNoMilestoneFound struct {
	Title string
}

ErrNoMilestoneFound is an error when no milestone is found.

func (ErrNoMilestoneFound) Error

func (e ErrNoMilestoneFound) Error() string

type Info

type Info struct {
	Description string
	Homepage    string
	URL         string
}

Info of the repository.

type NotImplementedError

type NotImplementedError struct {
	TokenType context.TokenType
}

NotImplementedError happens when trying to use something a client does not implement.

func (NotImplementedError) Error

func (e NotImplementedError) Error() string

type Repo

type Repo struct {
	Owner string
	Name  string
}

func RepoFromRef

func RepoFromRef(ref config.RepoRef) Repo

func (Repo) String

func (r Repo) String() string

type RetriableError

type RetriableError struct {
	Err error
}

RetriableError is an error that will cause the action to be retried.

func (RetriableError) Error

func (e RetriableError) Error() string