drift

package
v2.2.0 Latest Latest
Warning

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

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

Documentation

Overview

Package drift compares cidx.toml declarations with actual CI platform configuration.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Format 

func Format(result *Result) string

Format renders the drift result as a human-readable table.

Types

type PhaseDiff 

type PhaseDiff struct {
	Name   string
	CIDX   bool // present in cidx.toml
	CI     bool // present in CI workflow
	Status Status
}

PhaseDiff represents a phase comparison result.

type Result 

type Result struct {
	Workflow string // workflow file the config was compared against
	Pipeline string // pipeline the workflow implements ("" = every pipeline)
	Phases   []PhaseDiff
	Triggers []TriggerDiff
}

Result holds the complete drift analysis.

func Compare 

func Compare(cfg *config.Config, workflowPath string) (*Result, error)

Compare analyzes drift between cidx.toml config and a GitHub Actions workflow file.

func CompareFromData 

func CompareFromData(cfg *config.Config, workflowPath string, workflowData []byte) (*Result, error)

CompareFromData analyzes drift using raw YAML data. workflowPath is not read; it names the workflow so the comparison can be scoped to the pipeline that workflow implements (see pipelineFor).

func (*Result) DiffCount 

func (r *Result) DiffCount() int

DiffCount returns the number of differences found.

func (*Result) HasDrift 

func (r *Result) HasDrift() bool

HasDrift returns true if any differences were found.

type Status 

type Status string

Status represents the drift status of an item. 

const (
	StatusMatch   Status = "match"
	StatusMissing Status = "missing from CI"
	StatusExtra   Status = "extra in CI"
)

type TriggerDiff 

type TriggerDiff struct {
	Event  string
	CIDX   bool // expected from cidx.toml pipeline names
	CI     bool // present in CI workflow
	Status Status
}

TriggerDiff represents a trigger comparison result.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.