onboarder

Documentation

Overview

Package onboarder orchestrates the local onboarding flow.

Index

• func Run(ctx context.Context, dir string, opts Options) error
• type Options

Functions

func Run

func Run(ctx context.Context, dir string, opts Options) error

Run generates a starter config for a repository when it has none, and ensures the CLI has an authenticated CircleCI session.

Types

type Options

type Options struct {
	ConfigPath    string
	NoBrowser     bool
	SecureStorage bool
	Scan          bool
	Signup        bool
	// RepoID is the provider's repository ID used to wire up the first pipeline
	// definition and trigger. When empty it is resolved through the integration
	// that owns the checkout's remote; if that cannot resolve it, pipeline setup is
	// skipped with manual guidance. It is never prompted for — an opaque ID is not
	// something a user can be expected to know.
	RepoID string
}

Options configures the onboarding flow.