version

Documentation

Index

• type Asset
• type Author
• type Checker
  • func NewChecker(owner, repo, userAgent string) *Checker
  • func (c *Checker) CheckNewVersion(ctx context.Context, version string) (bool, *Release, error)
• type Release

Types

type Asset

type Asset struct {
	URL                string    `json:"url"`
	ID                 int64     `json:"id"`
	NodeID             string    `json:"node_id"`
	Name               string    `json:"name"`
	Label              string    `json:"label"`
	Uploader           Author    `json:"uploader"`
	ContentType        string    `json:"content_type"`
	State              string    `json:"state"`
	Size               int64     `json:"size"`
	DownloadCount      int64     `json:"download_count"`
	CreatedAt          time.Time `json:"created_at"`
	UpdatedAt          time.Time `json:"updated_at"`
	BrowserDownloadURL string    `json:"browser_download_url"`
}

Asset models a downloadable artifact for a release.

type Author

type Author struct {
	Login      string `json:"login"`
	ID         int64  `json:"id"`
	NodeID     string `json:"node_id"`
	AvatarURL  string `json:"avatar_url"`
	GravatarID string `json:"gravatar_id"`
	URL        string `json:"url"`
	HTMLURL    string `json:"html_url"`
	Type       string `json:"type"`
}

Author represents the author of a release.

type Checker

type Checker struct {
	Owner     string
	Repo      string
	UserAgent string
	// contains filtered or unexported fields
}

Checker talks to api.autobrr.com to determine whether a newer release is available.

func NewChecker

func NewChecker(owner, repo, userAgent string) *Checker

NewChecker returns a configured Checker for the provided repository.

func (*Checker) CheckNewVersion

func (c *Checker) CheckNewVersion(ctx context.Context, version string) (bool, *Release, error)

CheckNewVersion returns whether a newer release is available and the release metadata.

type Release

type Release struct {
	ID              int64     `json:"id,omitempty"`
	NodeID          string    `json:"node_id,omitempty"`
	URL             string    `json:"url,omitempty"`
	HTMLURL         string    `json:"html_url,omitempty"`
	TagName         string    `json:"tag_name,omitempty"`
	TargetCommitish string    `json:"target_commitish,omitempty"`
	Name            *string   `json:"name,omitempty"`
	Body            *string   `json:"body,omitempty"`
	Draft           bool      `json:"draft,omitempty"`
	Prerelease      bool      `json:"prerelease,omitempty"`
	CreatedAt       time.Time `json:"created_at"`
	PublishedAt     time.Time `json:"published_at"`
	Author          Author    `json:"author"`
	Assets          []Asset   `json:"assets"`
}

Release models the parts of a GitHub release we care about.