examples

package
v0.42.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2026 License: Apache-2.0 Imports: 35 Imported by: 0

Documentation

Overview

Package examples renders the example distro.yaml packages under example/ from the shared templates, one per distro flavor and release tag.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RenderAll

func RenderAll() error

RenderAll renders every example distro.yaml from the shared templates.

func RenderLine

func RenderLine(distro, prefix string) error

RenderLine backfills an example for every release on one minor line of a distro.

func VerifyAssets added in v0.37.0

func VerifyAssets() error

VerifyAssets re-fetches every image manifest example/assets.json has cached and compares it against what upstream serves now.

The committed cache is what makes the examples renderable offline, and it is also a pin with nothing watching it: a release whose assets Rancher or k3s re-cut in place keeps rendering from the copy taken the day it was first fetched, and the rendered examples go on naming images that may no longer exist. Nothing fails, which is the problem. This target is the human-run owner of that pin -- it reads no cache, so it costs one request per manifest, and it reports rather than rewrites. `CARGOSHIP_EXAMPLES_NO_CACHE=1 mage generate:examples` is what applies the fix once it has told you there is one.

Types

This section is empty.

Jump to

Keyboard shortcuts

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