version

Documentation

Index

• Constants
• type CheckResult
  • func CheckForUpdate() (*CheckResult, error)
• type GitHubRelease

Constants

const Version = "1.7.0"

Version is the current version of MinimalDoc

Types

type CheckResult

type CheckResult struct {
	CurrentVersion  string
	LatestVersion   string
	UpdateAvailable bool
	ReleaseURL      string
	PublishedAt     string
	ReleaseNotes    string
}

CheckResult contains the result of a version check

func CheckForUpdate

func CheckForUpdate() (*CheckResult, error)

CheckForUpdate checks if a newer version is available on GitHub

type GitHubRelease

type GitHubRelease struct {
	TagName     string `json:"tag_name"`
	Name        string `json:"name"`
	PublishedAt string `json:"published_at"`
	HTMLURL     string `json:"html_url"`
	Body        string `json:"body"`
}

GitHubRelease represents the GitHub API response for a release