updatechecker

package module

v0.0.3 Latest Latest Go to latest Published: May 14, 2021 License: MPL-2.0 Imports: 8 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

Repository

github.com/Christian1984/go-update-checker

Links

Open Source Insights

README ¶

Version Checker for Go

go-update-checker is a go library for checking the version of a currently installed application or package against its latest release on github. It also enables caching and setting a minimum interval of days after which a updatecheck against the github API should be performed to prevent spamming the API.

Versions used with go-update-checker must follow SemVer.

Installation and Usage

Installation can be done with a normal go get:

$ go get github.com/Christian1984/go-update-checker

Update Check Example

import (
    "fmt"

    updatechecker "github.com/Christian1984/go-update-checker"
)

func main() {
    uc := updatechecker.New("Christian1984", "go-update-checker", "Go Update Checker", "", 0, true, false)
    uc.CheckForUpdate("0.0.1")
    uc.PrintMessage()
    /*
    =============================================================
    === INFO: A new update is available for Go Update Checker ===

    Version: 0.0.2

    Title: Go Update Checker - 0.0.2

    Description:
    Changed receivers to pointer receivers


    Download the latest version here:
    https://github.com/Christian1984/go-update-checker/releases
    =============================================================
    */

    uc.CheckForUpdate("0.0.2")
    uc.PrintMessage()
    /*
    ========================================================================
    === INFO: You are running the latestest Version of Go Update Checker ===
    ========================================================================
    */

    /* alternatively use uc.Message (type string) in any other context */
}

Issues and Contributing

If you find an issue with this library, please report an issue. If you'd like, we welcome any contributions. Fork this library and submit a pull request.

Documentation ¶

Index ¶

Constants
func New(owner string, repo string, software string, downloadLink string, ...) updateChecker
type CheckData
type GithubApiResponseData

Constants ¶

View Source

const DateFormat string = time.UnixDate

View Source

const Filename string = "latestcheck.json"

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(owner string, repo string, software string, downloadLink string, minDaysInterval int, verbose bool) updateChecker

Types ¶

type CheckData ¶

type CheckData struct {
	Timestamp   string `json:"timestamp"`
	Version     string `json:"version"`
	Name        string `json:"name"`
	Description string `json:"description"`
}

type GithubApiResponseData ¶

type GithubApiResponseData struct {
	Version     string `json:"tag_name"`
	Name        string `json:"name"`
	Description string `json:"body"`
}

Source Files ¶

View all Source files

updatechecker.go

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