Categorygithub.com/gleich/release
repositorypackage
0.0.0-20230101033802-94e8f26aab77
Repository: https://github.com/gleich/release.git
Documentation: pkg.go.dev

# README

release

šŸ“¦ go package to check for a new GitHub release

build test lint release

šŸš€ Install

Simply run the following in the root of your project directory:

go get -u github.com/gleich/release

šŸ“„ Documentation GoDoc

func Check

func Check(currentVersion string, repoURL string) (bool, string, error)

Check for an update. Takes in the current version and GitHub repo URL. Returns true or false if there is an update or not as well as the version value. Will return false if there is no network connection.

Example

package main

import "github.com/gleich/release"

func main() {
    isOutdated, version, err := release.Check("v1.0.0", "https://github.com/gleich/nuke/")
}

šŸ™Œ Contributing

Before contributing please read the CONTRIBUTING.md file

šŸ‘„ Contributors