codecov

README

go-codecov

Global coverage report uploader for Codecov written in Go.

Related repositories

Official

• codecov/uploader
• codecov/codecov-bash: Global coverage report uploader for Codecov
• codecov/codecov-node: Global coverage report uploader for Codecov in NodeJS
• codecov/codecov-python: Python report uploader for Codecov
• codecov/codecov-ruby: Ruby uploader for Codecov
• codecov/codecov-perl: Backend for Codecov reporting of coverage

Documentation

Index

• Constants
• func DefaultClient() *http.Client
• type Client
  • func NewClient(hc *http.Client) *Client
  • func (c *Client) Compress(reports []byte) (io.Reader, error)
  • func (c *Client) Prepare(ctx context.Context) (ep Endpoint, err error)
  • func (c *Client) Service()
  • func (c *Client) Upload(ctx context.Context, ep Endpoint, reports io.Reader) error
• type Endpoint

Constants

const Token = "CODECOV_TOKEN"

Token is the Codecov token environment variable.

Functions

func DefaultClient

func DefaultClient() *http.Client

DefaultClient returns the default http.Client for send to Codecov.

Types

type Client

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

Client represents a CodeCov client.

func NewClient

func NewClient(hc *http.Client) *Client

NewClient returns the new Codecov client.

func (*Client) Compress

func (c *Client) Compress(reports []byte) (io.Reader, error)

Compress compresses coverage reports in gzip format.

func (*Client) Prepare

func (c *Client) Prepare(ctx context.Context) (ep Endpoint, err error)

Prepare prepares Codecov endpoint.

func (*Client) Service

func (c *Client) Service()

Service returns the detected service configurations.

This method mainly for debug to detect services.

func (*Client) Upload

func (c *Client) Upload(ctx context.Context, ep Endpoint, reports io.Reader) error

Upload uploads coverage reports to Codecov endpoint.

type Endpoint

type Endpoint struct {
	// URL is the url of Codecov endpoint.
	URL string

	// S3URL is the s3 url of Codecov endpoint.
	S3URL string
}

Endpoint represents a Codecov upload endpoint url and s3 url.