git

Documentation

Index

• func IsNotFound(err error) bool
• type SCM
• type SCMClient
  • func New(c *scm.Client, s secrets.SecretGetter, m metrics.Interface) *SCMClient
  • func (c *SCMClient) CreateStatus(ctx context.Context, repo, commit string, s *scm.StatusInput) error
  • func (c *SCMClient) FileContents(ctx context.Context, repo, path, ref string) ([]byte, error)
  • func (c *SCMClient) ParseWebhookRequest(req *http.Request) (scm.Webhook, error)

Functions

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns true if the error represents a NotFound response from an upstream service.

Types

type SCM

type SCM interface {
	// ParseWebhookRequest returns the webhook payload.
	ParseWebhookRequest(req *http.Request) (scm.Webhook, error)
	// FileContents returns the contents of a file within a repo.
	FileContents(ctx context.Context, repo, path, ref string) ([]byte, error)
	// CreateStatus creates a new commit status for the repo/commit combination.
	CreateStatus(ctx context.Context, repo, commit string, s *scm.StatusInput) error
}

SCM is a wrapper around go-scm's Client implementation.

type SCMClient

type SCMClient struct {
	// contains filtered or unexported fields
}

SCMClient is a wrapper for the go-scm scm.Client with a simplified API.

func New

func New(c *scm.Client, s secrets.SecretGetter, m metrics.Interface) *SCMClient

New creates and returns a new SCMClient.

func (*SCMClient) CreateStatus

func (c *SCMClient) CreateStatus(ctx context.Context, repo, commit string, s *scm.StatusInput) error

CreateStatus creates a commit status.

If an HTTP error is returned by the upstream service, an error with the response status code is returned.

func (*SCMClient) FileContents

func (c *SCMClient) FileContents(ctx context.Context, repo, path, ref string) ([]byte, error)

FileContents reads the specific revision of a file from a repository.

If an HTTP error is returned by the upstream service, an error with the response status code is returned.

func (*SCMClient) ParseWebhookRequest

func (c *SCMClient) ParseWebhookRequest(req *http.Request) (scm.Webhook, error)

ParseWebhookRequest parses an incoming hook request and returns a parsed hook response if one can be matched.