preflight

package

v0.4.26 Latest Latest Go to latest Published: Oct 26, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

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

Repository

github.com/mcpdev80/baseharbor

Links

Open Source Insights

Documentation ¶

Index ¶

func Format(w io.Writer, results []Result)
type Check
type Result
- func Run(ctx context.Context, checks []Check) ([]Result, bool)
- func RunWithTimeout(ctx context.Context, checks []Check, timeout time.Duration) ([]Result, bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Format ¶

func Format(w io.Writer, results []Result)

Types ¶

type Check ¶

type Check struct {
	Name string
	Run  func(context.Context) error
}

type Result ¶

type Result struct {
	Name   string `json:"name"`
	OK     bool   `json:"ok"`
	Detail string `json:"detail,omitempty"`
	Err    error  `json:"-"`
}

func Run ¶

func Run(ctx context.Context, checks []Check) ([]Result, bool)

func RunWithTimeout ¶ added in v0.4.14

func RunWithTimeout(ctx context.Context, checks []Check, timeout time.Duration) ([]Result, bool)

RunWithTimeout gives every check its own timeout budget. A single shared deadline makes later checks fail only because earlier runtime checks were slow, which is especially visible with external Compose providers.

Source Files ¶

View all Source files

preflight.go

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