publish

package
v0.13.2 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2026 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Overview

Package publish is `anfra publish`: a local repo's files published to its org, as PUBLISH.md (anfra-cloud) describes. The command wires it to the terminal (Env); its messages name the command's flags.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Confirm

func Confirm(ask Prompt, question string) (yes, ok bool)

Confirm asks a yes-or-no question, no the default.

func Run

func Run(ctx context.Context, dir string, o Options, env Env) error

Run publishes the repo at dir: PUBLISH.md's flow, from file selection to the server's answer. Progress goes to env.ErrOut; the outcome to env.Out.

Types

type Env

type Env struct {
	Out, ErrOut io.Writer
	Ask         Prompt
	// Validate validates the repo here, before anything is sent: showing what
	// fails on its writer, and an error refusing the publish. Always, and again on
	// the server, whose verdict on exactly the published files is the one that
	// publishes (PUBLISH.md §Decisions).
	Validate func(context.Context, io.Writer) error
	// Credential checks the selected login before destination configuration is
	// saved, returning an authorizer that resolves credentials for every request.
	Credential func(context.Context, cloudapi.Org) (func(*http.Request) error, error)
	// SelectOrg explicitly selects a first destination; nil means no interactive terminal.
	SelectOrg func(context.Context) (cloudapi.Org, error)
	// RecoverOrg offers interactive recovery after credential loading fails.
	// It must return the original error when recovery does not apply, and confirm
	// any destination change before returning a different organization.
	RecoverOrg func(context.Context, cloudapi.Org, error) (cloudapi.Org, error)
	// UserAgent names the CLI and its version, for the server.
	UserAgent string
	// MotherDuck is the person's MotherDuck account, to copy a DuckDB data source
	// to; nil offers no copy.
	MotherDuck MotherDuck
	// Input asks for a line of text, as Ask asks a question; nil with no
	// terminal.
	Input Input
}

Env is what a publish needs from the command around it.

type Input added in v0.13.0

type Input func(question string) (answer string, ok bool)

Input asks for a line of text, and returns it trimmed: "" when nothing was typed, or the question was interrupted; ok is false when nobody can answer it.

type MotherDuck added in v0.13.0

type MotherDuck interface {
	Find(ctx context.Context) (version string, ok bool)
	Status(ctx context.Context) (motherduck.Status, error)
	Login(ctx context.Context) error
	Session(ctx context.Context) (token string, databases []string, err error)
	DatabaseExists(ctx context.Context, name string) (bool, error)
	CreateDatabaseFrom(ctx context.Context, name, path string) error
	CreateReadToken(ctx context.Context, session, username, name, description string) (motherduck.Token, error)
	RevokeToken(ctx context.Context, session, username, id string) error
}

MotherDuck is a person's MotherDuck account, as copying a DuckDB file there needs it (motherduck.Account). Nil offers no copy: without a terminal, nobody is there to sign in.

type Options

type Options struct {
	// Message is what the publish is, for the org's history of the repo; "" is
	// HEAD's commit, in a git repo.
	Message string
	// SetOrg is an org's address to record as the repo's, and publish to.
	SetOrg string
	// DryRun lists the files and stops.
	DryRun bool
	// Yes publishes without asking, though the repo was last published elsewhere.
	Yes bool
	// CreateDataSources adds the data sources the repo uses and the org lacks
	// without asking.
	CreateDataSources bool
}

Options are a publish's choices: the command's flags.

type Prompt

type Prompt func(question string, choices ...string) (choice int, ok bool)

Prompt asks a question with choices, the last one the default (the safe answer), and returns the choice's index; ok is false when nobody can answer it (not a terminal).

Jump to

Keyboard shortcuts

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