producer

package

v0.22.0 Latest Latest Go to latest Published: Sep 17, 2026 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/strongo/cli-helpers

Links

Open Source Insights

Documentation ¶

Overview ¶

Package producer builds one immutable skillsync release snapshot from an already-checked-out local Git repository. It never fetches or downloads: CI resolves branches and tags before invoking it, then this package reads the exact full commit named by the descriptor.

Index ¶

type Config
type Result
- func Produce(config Config) (Result, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Descriptor    skillsync.BundleDescriptor
	RepositoryDir string
	OutputDir     string
}

Config names the committed plugin tree and a fresh destination directory. Descriptor.Source.Revision must be a full immutable SHA; Digest is optional and, when supplied, must match the captured committed bytes.

type Result ¶

type Result struct {
	Descriptor     skillsync.BundleDescriptor
	ArchivePath    string
	DescriptorPath string
	EmbedDir       string
}

Result identifies the canonical files published into OutputDir.

func Produce ¶

func Produce(config Config) (Result, error)

Produce creates skillsync-bundle.tar, skillsync-bundle.json, and embed/{bundle.json,content/...} from the same verified captured tree. The output path must not already exist. On any failure it returns no Result and removes its unpublished staging directory.

Source Files ¶

View all Source files

producer.go

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