updatecheck

package module

v0.3.5 Latest Latest Go to latest Published: Aug 18, 2023 License: MIT Imports: 13 Imported by: 1

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

This section is empty.

This section is empty.

func Check(app App, currentVersion string, prod bool, opts ...func(*Options))

Check for updates to the CLI application. Update checking happens in the background, call Print() to print the update message.

'prod' should be true if the build is a production build.

func Print()

Print whether any updates are required.

type App string

App is the application we are checking for updates to.

const (
	GrantedCLI App = "granted-cli"
)

type Options struct {
	Client *http.Client
	// URL is the update checking endpoint.
	URL string
}

Options allows aspects of the update checking to be customised.

Path	Synopsis
example