Help us shape the future of Go! Take the 2026 Go Developer Survey

config

package
v0.1.8 Latest Latest
Warning

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

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

Documentation

Overview

Package config loads .deadvalues.yaml.

Index

Constants

View Source
const FileName = ".deadvalues.yaml"

Variables

This section is empty.

Functions

func Default

func Default(repoRoot string) string

func Match

func Match(pattern string, key []string) bool

Match reports whether pattern matches key or one of its ancestors.

Types

type Config

type Config struct {
	KubeVersion string   `json:"kubeVersion"`
	APIVersions []string `json:"apiVersions"`
	FailOn      string   `json:"failOn"`
	Ignore      []Ignore `json:"ignore"`
	Flux        Flux     `json:"flux"`
}

func Load

func Load(p string, required bool) (*Config, error)

Load reads path. A missing file is an error only when required is true.

func (*Config) Ignored

func (c *Config) Ignored(app string, key []string) bool

type Flux

type Flux struct {
	Substitute map[string]string `json:"substitute"`
}

Flux holds values for ${var} placeholders that Flux postBuild substitution fills in at reconcile time.

type Ignore

type Ignore struct {
	App  string   `json:"app"`
	Keys []string `json:"keys"`
}

Ignore accepts keys on purpose. Without App it applies to every app. Keys are dotted patterns: `*` matches one segment, `**` any number of segments, and a pattern matching a map also covers everything under it.

Jump to

Keyboard shortcuts

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