util

package

v0.2.8 Latest Latest Go to latest Published: Jun 7, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

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

Repository

github.com/DragonSecurity/gomgr

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Audit(scope, target, action, status string)
func Debugf(format string, args ...any)
func EnableDebug()
func Infof(format string, args ...any)
func Logger() *slog.Logger
func PrintPlan(p Plan) error
func PrintSummary(p Plan)
func Warnf(format string, v ...any)
type Change
type Plan
type StatePair
type StateStats

Constants ¶

This section is empty.

Variables ¶

View Source

var AuditLog bool

AuditLog controls whether structured audit log entries are emitted to stderr.

Functions ¶

func Audit ¶ added in v0.2.3

func Audit(scope, target, action, status string)

Audit emits a structured JSON audit log entry to stderr when AuditLog is enabled.

func Debugf ¶ added in v0.2.4

func Debugf(format string, args ...any)

Debugf emits a formatted debug-level log line via slog.

func EnableDebug ¶

func EnableDebug()

EnableDebug switches the package logger to debug level and prefixes records with file:line so operators can trace noisy runs.

func Infof ¶ added in v0.2.4

func Infof(format string, args ...any)

Infof emits a formatted info-level log line via slog.

func Logger ¶ added in v0.2.4

func Logger() *slog.Logger

Logger returns the package-level structured logger.

func PrintPlan ¶

func PrintPlan(p Plan) error

PrintPlan writes the plan's changes as a short, one-line-per-change list. File contents and other verbose detail fields are omitted; the summary block printed by PrintSummary carries the aggregate stats.

func PrintSummary ¶

func PrintSummary(p Plan)

PrintSummary prints a human-readable summary of the plan

func Warnf ¶

func Warnf(format string, v ...any)

Warnf prints a warning message to stderr.

Types ¶

type Change ¶

type Change struct {
	Scope   string      `json:"scope"`
	Target  string      `json:"target"`
	Action  string      `json:"action"`
	Details interface{} `json:"details"`
}

type Plan ¶

type Plan struct {
	Changes  []Change    `json:"changes"`
	Warnings []string    `json:"warnings"`
	Stats    *StateStats `json:"stats,omitempty"`
}

type StatePair ¶

type StatePair struct {
	Current int `json:"current"`
	Desired int `json:"desired"`
}

type StateStats ¶

type StateStats struct {
	Teams           StatePair `json:"teams"`
	TeamMembers     StatePair `json:"team_members"`
	Repositories    StatePair `json:"repositories"`
	RepoPermissions StatePair `json:"repo_permissions"`
	CustomRoles     StatePair `json:"custom_roles"`
}

Source Files ¶

View all Source files

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