maturity

package
v2.3.1 Latest Latest
Warning

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

Go to latest
Published: May 25, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package maturity implements maturity-level gating for kong commands.

Commands are tagged with `maturity:"alpha"` or `maturity:"beta"` (GA commands have no tag). When a maturity level is not enabled, commands at that level are hidden from help output but still callable. Their own help text is annotated with a banner indicating the level.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Apply

func Apply(app *kong.Application, enabled map[Level]bool)

Apply walks the kong model and applies maturity gating:

  • Nodes whose effective level is not in enabled are marked Hidden.
  • Every non-GA node has a banner prepended to its Help and Detail so invokers can tell from `--help` what maturity they are using.

A node's effective level is the maturity tag on the node itself, or inherited from its nearest tagged ancestor.

Types

type Level

type Level string

Level is a command maturity level.

const (
	// LevelGA is the default level for stable, generally available commands.
	LevelGA Level = ""
	// LevelBeta marks commands that may change before becoming GA.
	LevelBeta Level = "beta"
	// LevelAlpha marks experimental commands that may be removed.
	LevelAlpha Level = "alpha"
)

Jump to

Keyboard shortcuts

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