update

Documentation

Overview

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com>

SPDX-License-Identifier: BSD-3-Clause

Index

• Variables
• func FindAndCheckAssetDigest(a ReleaseAsset, cs map[string]string) (string, error)
• func LatestRelease(ctx context.Context) string
• func Update(ctx context.Context, options ...UpdateOption) error
• type ReleaseAsset
• type RepositoryRelease
• type UpdateOption
  • func WithDryRun() UpdateOption
  • func WithIgnoreDigest() UpdateOption
  • func WithIgnoreSignature() UpdateOption
• type UpdatePolicy
  • func (up *UpdatePolicy) Check() error

Variables

var GhURL = "https://api.github.com/repos/outscale/octl/releases/latest"

Functions

func FindAndCheckAssetDigest

func FindAndCheckAssetDigest(a ReleaseAsset, cs map[string]string) (string, error)

func LatestRelease

func LatestRelease(ctx context.Context) string

func Update

func Update(ctx context.Context, options ...UpdateOption) error

Types

type ReleaseAsset

type ReleaseAsset struct {
	Name               string `json:"name,omitempty"`
	BrowserDownloadURL string `json:"browser_download_url,omitempty"`
	Digest             string `json:"digest,omitempty"`
}

ReleaseAsset represents a GitHub release asset in a repository.

type RepositoryRelease

type RepositoryRelease struct {
	TagName string         `json:"tag_name,omitempty"`
	Body    string         `json:"body,omitempty"`
	Assets  []ReleaseAsset `json:"assets,omitempty"`
}

RepositoryRelease represents a GitHub release in a repository.

type UpdateOption

type UpdateOption func(*UpdatePolicy)

func WithDryRun

func WithDryRun() UpdateOption

WithDryRun creates an option that runs the full verification pipeline (signature, checksum) but skips the final binary replacement step. Useful for testing.

func WithIgnoreDigest

func WithIgnoreDigest() UpdateOption

WithIgnoreDigest creates an option to ignore digest/checksum verification during update.

func WithIgnoreSignature

func WithIgnoreSignature() UpdateOption

WithIgnoreSignature creates an option to ignore signature verification during update.

type UpdatePolicy

type UpdatePolicy struct {
	// contains filtered or unexported fields
}

func (*UpdatePolicy) Check

func (up *UpdatePolicy) Check() error