Documentation
¶
Overview ¶
Package update implements self-update: it compares the running version against GitHub releases and downloads, checksum-verifies, and installs a newer binary, skipping Homebrew and go-install builds.
Index ¶
- Constants
- func CanWrite(path string) bool
- func ExtractBinary(archivePath, destDir string) (string, error)
- func GetCurrentBinaryPath() (string, error)
- func GetPlatformAssetName(version string) string
- func InstallBinary(newBinaryPath, currentBinaryPath string) error
- func IsDevBuild(version string) bool
- func IsGoInstall() bool
- func IsHomebrewBuild() bool
- func VerifyChecksum(filepath, expectedChecksum string) error
- func VerifyMinisign(message, sig []byte, pubKeyB64 string) error
- type Asset
- type CheckResult
- type GitHubClient
- func (c *GitHubClient) DownloadAsset(url string, w io.Writer) error
- func (c *GitHubClient) FetchChecksums(release *Release) (map[string]string, error)
- func (c *GitHubClient) FetchChecksumsRaw(release *Release) ([]byte, error)
- func (c *GitHubClient) FetchLatestRelease() (*Release, error)
- func (c *GitHubClient) FetchSignature(release *Release) ([]byte, error)
- type Release
- type Updater
- type Version
Constants ¶
const ( // GitHubOwner is the GitHub owner for amux. GitHubOwner = "andyrewlee" // GitHubRepo is the GitHub repo for amux. GitHubRepo = "amux" // GitHubAPIBase is the base URL for GitHub API. GitHubAPIBase = "https://api.github.com" )
Variables ¶
This section is empty.
Functions ¶
func ExtractBinary ¶
ExtractBinary extracts the amux binary from a tar.gz archive. Returns the path to the extracted binary.
func GetCurrentBinaryPath ¶
GetCurrentBinaryPath returns the path to the currently running binary.
func GetPlatformAssetName ¶
GetPlatformAssetName returns the expected asset name for the current platform.
func InstallBinary ¶
InstallBinary performs an atomic replacement of the current binary. It stages the new binary in the same directory as the target to avoid cross-filesystem rename issues, then uses rename to atomically swap.
func IsDevBuild ¶
IsDevBuild returns true if this is a development build.
func IsGoInstall ¶
func IsGoInstall() bool
IsGoInstall returns true if the binary appears to be installed via `go install`.
func IsHomebrewBuild ¶ added in v0.0.10
func IsHomebrewBuild() bool
IsHomebrewBuild returns true when the binary was built for Homebrew.
func VerifyChecksum ¶
VerifyChecksum verifies a file's SHA256 checksum.
func VerifyMinisign ¶ added in v0.0.20
VerifyMinisign verifies that sig is a valid minisign signature over message, made by the key whose base64 public key is pubKeyB64. It returns nil on a valid signature and a non-nil error otherwise (including malformed inputs).
Types ¶
type Asset ¶
type Asset struct {
Name string `json:"name"`
BrowserDownloadURL string `json:"browser_download_url"`
Size int64 `json:"size"`
ContentType string `json:"content_type"`
}
Asset represents a release asset.
func FindPlatformAsset ¶
FindPlatformAsset finds the appropriate asset for the current platform.
type CheckResult ¶
type CheckResult struct {
CurrentVersion string
LatestVersion string
UpdateAvailable bool
ReleaseNotes string
Release *Release
}
CheckResult contains the result of an update check.
type GitHubClient ¶
type GitHubClient struct {
// contains filtered or unexported fields
}
GitHubClient handles GitHub API interactions.
func NewGitHubClient ¶
func NewGitHubClient() *GitHubClient
NewGitHubClient creates a new GitHub client.
func (*GitHubClient) DownloadAsset ¶
func (c *GitHubClient) DownloadAsset(url string, w io.Writer) error
DownloadAsset downloads an asset to the specified writer.
func (*GitHubClient) FetchChecksums ¶
func (c *GitHubClient) FetchChecksums(release *Release) (map[string]string, error)
FetchChecksums downloads and returns the parsed checksums.txt content.
func (*GitHubClient) FetchChecksumsRaw ¶ added in v0.0.20
func (c *GitHubClient) FetchChecksumsRaw(release *Release) ([]byte, error)
FetchChecksumsRaw downloads the raw checksums.txt bytes from the release. Callers that verify the release signature must use these exact bytes as the signed message; parsing first would discard the signed input.
func (*GitHubClient) FetchLatestRelease ¶
func (c *GitHubClient) FetchLatestRelease() (*Release, error)
FetchLatestRelease fetches the latest release from GitHub.
func (*GitHubClient) FetchSignature ¶ added in v0.0.20
func (c *GitHubClient) FetchSignature(release *Release) ([]byte, error)
FetchSignature downloads the detached minisign signature over checksums.txt.
type Release ¶
type Release struct {
TagName string `json:"tag_name"`
Name string `json:"name"`
Body string `json:"body"`
Draft bool `json:"draft"`
Prerelease bool `json:"prerelease"`
PublishedAt time.Time `json:"published_at"`
Assets []Asset `json:"assets"`
}
Release represents a GitHub release.
type Updater ¶
type Updater struct {
// ForceDowngrade permits installing a release whose version is strictly
// lower than the running version. Default false (safe): Upgrade refuses
// downgrades so a re-pointed "latest" tag cannot roll back to an older,
// still validly-signed release. Callers set it only for deliberate,
// operator-driven downgrades.
ForceDowngrade bool
// contains filtered or unexported fields
}
Updater orchestrates the check and upgrade workflow.
func NewUpdater ¶
NewUpdater creates a new Updater.
func (*Updater) Check ¶
func (u *Updater) Check() (*CheckResult, error)
Check checks for available updates.
Source Files