yaml

package
v1.229.0 Latest Latest
Warning

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

Go to latest
Published: Sep 16, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package yaml implements the yaml file manager: in-place field writes on existing YAML files (values files, extra config, and similar), configured via `options.set: [{path, from, format}]`. It reuses Atmos's own format-preserving YAML editor (pkg/yaml, the same engine behind `atmos config set` and `atmos stack set`), which edits via a yq expression rather than a full unmarshal/remarshal, so comments, anchors, and key order on untouched fields survive the write. Path syntax is the same dot-notation used by those commands (e.g. `sources[0].version`, `metadata."weird.key"`), not the sjson/gjson dialect the json manager uses.

Index

Constants

View Source
const Name = "yaml"

Name is the manager's registry name.

Variables

This section is empty.

Functions

This section is empty.

Types

type Manager

type Manager struct{}

Manager writes locked values into YAML files at configured field paths.

func (Manager) DefaultPaths

func (Manager) DefaultPaths() []string

DefaultPaths is empty: like the json manager, there is no generically-safe default glob for "YAML files this tool owns" -- the yaml manager only runs over configured paths.

func (Manager) Name

func (Manager) Name() string

Name returns the manager's registry name.

func (Manager) Plan

Plan scans the configured files and returns the field writes needed to match the locked versions.

Jump to

Keyboard shortcuts

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