marker

package

v1.223.0 Latest Latest Go to latest Published: Jul 15, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

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

Repository

github.com/cloudposse/atmos

Links

Documentation ¶

Overview ¶

Package marker implements the marker file manager: the Renovate regex-manager equivalent for arbitrary text files. A comment annotation

<comment> atmos:version <entry-name> [match=<regex-with-one-capture-group>]

marks a line (trailing comment) or the next non-blank, non-comment line (standalone comment) as carrying a managed version. The manager rewrites the version token in place from the lock. Comment delimiters are detected per language (#, //, ;, --, <!--, /*), so the annotation works across YAML, shell, Dockerfiles, Go, SQL, HTML, and more. Formats without comments (JSON) should use the template manager instead.

Constants ¶

View Source

const Name = "marker"

Name is the manager's registry name.

Variables ¶

View Source

var (
	// ErrBadMatchExpression is returned for a match= regex that does not
	// compile or lacks a capture group.
	ErrBadMatchExpression = errUtils.ErrVersionMarkerBadMatch
)

Functions ¶

This section is empty.

Types ¶

type Manager ¶

type Manager struct{}

Manager rewrites marker-annotated version tokens from the lock.

func (Manager) DefaultPaths ¶

func (Manager) DefaultPaths() []string

DefaultPaths is empty: the marker manager only runs over configured paths.

func (Manager) Name ¶

func (Manager) Name() string

Name returns the manager's registry name.

func (Manager) Plan ¶

func (Manager) Plan(ctx context.Context, in *managers.Input) ([]managers.FileChange, error)

Plan scans the configured files for annotations and returns the rewrites needed to match the locked versions.

Source Files ¶

View all Source files

marker.go

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