readiness

package
v0.2.4 Latest Latest
Warning

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

Go to latest
Published: Jul 28, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	StateOK      = "ok"
	StateWarn    = "warn"
	StateMissing = "missing"
	StateUnknown = "unknown"
)

Variables

This section is empty.

Functions

func ExpectedGeneratedFiles

func ExpectedGeneratedFiles() []string

func HasActiveProject

func HasActiveProject() bool

Types

type Check

type Check struct {
	Name    string `json:"name"`
	Status  string `json:"status"`
	Message string `json:"message"`
	Fix     string `json:"fix,omitempty"`
}

type Project

type Project struct {
	ID   string `json:"id,omitempty"`
	Path string `json:"path"`
	// Registered reports whether the user registered this directory. Only a
	// registered project has a credential set devvault trusts, so this is what
	// tells a consumer apart "no credentials configured yet" from "devvault
	// deliberately determines none".
	Registered    bool   `json:"registered"`
	Customer      string `json:"customer"`
	Name          string `json:"name"`
	CredentialSet string `json:"credential_set"`
	AWSProfile    string `json:"aws_profile"`
	Terraform     string `json:"terraform"`
	Backend       string `json:"backend"`
}

type Report

type Report struct {
	Project       Project               `json:"project"`
	Checks        []Check               `json:"checks"`
	BackendChecks []status.DoctorResult `json:"backend_checks"`
	ActiveBackend string                `json:"active_backend,omitempty"`
	OverallStatus string                `json:"overall_status"`
	NextCommands  []string              `json:"next_commands,omitempty"`
}

func Run

func Run(ctx context.Context, projectKey string) (Report, error)

Jump to

Keyboard shortcuts

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