update

package module

v0.0.0-...-dfe40a6 Latest Latest Go to latest Published: Mar 17, 2021 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/BGrewell/go-update

Links

Open Source Insights

README ¶

go-update

Package update provides tooling to auto-update binary releases from GitHub based on the user's current version and operating system. Used by command-line tools such as Up and Apex.

Documentation ¶

Overview ¶

Package update provides tooling to auto-update binary releases from GitHub based on the user's current version and operating system.

Index ¶

Variables
type Asset
type Manager
- func (m *Manager) Install(path string) error
- func (m *Manager) InstallTo(path, dir string) error
type Proxy
type Release
type Store

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrNotFound is returned from GetRelease if the release is not found.
	ErrNotFound = errors.New("release not found")
)

Errors.

View Source

var NopProxy = func(size int, r io.ReadCloser) io.ReadCloser {
	return r
}

NopProxy does nothing.

Functions ¶

This section is empty.

Types ¶

type Asset ¶

type Asset struct {
	Name      string // Name of the asset.
	Size      int    // Size of the asset.
	URL       string // URL of the asset.
	Downloads int    // Downloads count.
}

Asset represents a project release asset.

func (*Asset) Download ¶

func (a *Asset) Download() (string, error)

Download the asset to a tmp directory and return its path.

func (*Asset) DownloadProxy ¶

func (a *Asset) DownloadProxy(proxy Proxy) (string, error)

DownloadProxy the asset to a tmp directory and return its path.

func (*Asset) DownloadProxySecure ¶

func (a *Asset) DownloadProxySecure(proxy Proxy, token string) (string, error)

DownloadProxySecure the asset from a secure location to a tmp directory and return its path.

func (*Asset) DownloadSecure ¶

func (a *Asset) DownloadSecure(token string) (string, error)

Download the asset from a secure location to a tmp directory and return its path.

type Manager ¶

type Manager struct {
	Store          // Store for releases such as Github or a custom private store.
	Command string // Command is the executable's name.
}

Manager is the update manager.

func (*Manager) Install ¶

func (m *Manager) Install(path string) error

Install binary to replace the current version.

func (*Manager) InstallTo ¶

func (m *Manager) InstallTo(path, dir string) error

InstallTo binary to the given dir.

type Proxy ¶

type Proxy func(int, io.ReadCloser) io.ReadCloser

Proxy is used to proxy a reader, for example using https://github.com/cheggaaa/pb to provide progress updates.

type Release ¶

type Release struct {
	Version     string    // Version is the release version.
	Notes       string    // Notes is the markdown release notes.
	URL         string    // URL is the notes url.
	PublishedAt time.Time // PublishedAt is the publish time.
	Assets      []*Asset  // Assets is the release assets.
}

Release represents a project release.

func (*Release) FindTarball ¶

func (r *Release) FindTarball(os, arch string) *Asset

FindTarball returns a tarball matching os and arch, or nil.

func (*Release) FindZip ¶

func (r *Release) FindZip(os, arch string) *Asset

FindZip returns a zipfile matching os and arch, or nil.

func (*Release) Newer ¶

func (r *Release) Newer(currentVersion string) bool

type Store ¶

type Store interface {
	GetRelease(version string) (*Release, error)
	LatestReleases() ([]*Release, error)
}

Store is the interface used for listing and fetching releases.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
_example
latest
specific
progress Package progress provides a proxy for download progress.	Package progress provides a proxy for download progress.
stores
apex Package apex provides an Apex release store.	Package apex provides an Apex release store.
github Package github provides a GitHub release store.	Package github provides a GitHub release store.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL