onboarder

package
v1.0.47653 Latest Latest
Warning

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

Go to latest
Published: Aug 11, 2026 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

Package onboarder orchestrates the local onboarding flow.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Run

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

Run scans a repository, verifies its tests, generates a starter config when needed, 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 VCS repository external ID (the numeric GitHub repo ID) used
	// to wire up the first pipeline definition and trigger. When empty it is
	// resolved through the CircleCI GitHub App; if that cannot resolve it, pipeline
	// setup is skipped with manual guidance. It is never prompted for — an opaque
	// numeric ID is not something a user can be expected to know.
	RepoID string
}

Options configures the onboarding flow.

Jump to

Keyboard shortcuts

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