compilerenv

Documentation

Index

• Constants
• func BuildDefaultDetectionMaxAICreditsExpression(builtinDefault string) string
• func BuildDefaultMaxAICreditsExpression(builtinDefault string) string
• func BuildDefaultMaxDailyAICreditsExpression(builtinDefault string) string
• func BuildDefaultMaxTurnsExpression() string
• func BuildModelOverrideExpression(primaryVar, enterpriseDefaultVar, builtinFallback string) string
• func BuildModelOverrideExpressionEmptyFallback(primaryVar, enterpriseDefaultVar string) string
• func ResolveDefaultDetectionModel(fallback string) string
• func ResolveDefaultMaxTurnCacheMisses(fallback int) int
• func ResolveDefaultMaxTurns(fallback string) string
• func ResolveDefaultTimeoutMinutes(fallback int) int
• func ResolveDefaultUTC(fallback string) string
• func ResolvePolicyModelsAllowed() ([]string, bool)
• func ResolvePolicyModelsBlocked() ([]string, bool)
• type EnvGetter
• type Manager
  • func New(getenv EnvGetter) *Manager
  • func (m *Manager) ResolveDefaultDetectionModel(fallback string) string
  • func (m *Manager) ResolveDefaultMaxTurnCacheMisses(fallback int) int
  • func (m *Manager) ResolveDefaultMaxTurns(fallback string) string
  • func (m *Manager) ResolveDefaultTimeoutMinutes(fallback int) int
  • func (m *Manager) ResolveDefaultUTC(fallback string) string
  • func (m *Manager) ResolvePolicyModelsAllowed() ([]string, bool)
  • func (m *Manager) ResolvePolicyModelsBlocked() ([]string, bool)

Constants

const (
	// DefaultMaxDailyAICredits is the enterprise override for the top-level
	// max-daily-ai-credits guardrail when it is not explicitly configured in
	// workflow frontmatter.
	DefaultMaxDailyAICredits = "GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS"
	// DefaultMaxAICredits is the enterprise override for AWF apiProxy.maxAiCredits
	// when max-ai-credits is not explicitly configured in workflow frontmatter.
	DefaultMaxAICredits = "GH_AW_DEFAULT_MAX_AI_CREDITS"
	// DefaultMaxTurnCacheMisses is the enterprise override for AWF
	// apiProxy.maxCacheMisses when max-turn-cache-misses is not explicitly configured
	// in workflow frontmatter.
	DefaultMaxTurnCacheMisses = "GH_AW_DEFAULT_MAX_TURN_CACHE_MISSES"
	// DefaultDetectionMaxAICredits is the enterprise override for the
	// threat-detection AWF apiProxy.maxAiCredits budget when
	// safe-outputs.threat-detection.max-ai-credits is not explicitly configured.
	DefaultDetectionMaxAICredits = "GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS"
	// DefaultMaxTurns is the enterprise override for max-turns when it is not
	// explicitly configured in workflow frontmatter.
	DefaultMaxTurns = "GH_AW_DEFAULT_MAX_TURNS"
	// DefaultTimeoutMinutes is the enterprise override for top-level timeout-minutes
	// when it is not explicitly configured in workflow frontmatter.
	DefaultTimeoutMinutes = "GH_AW_DEFAULT_TIMEOUT_MINUTES"
	// DefaultDetectionModel is the enterprise override for selecting the detection
	// job model when threat-detection.engine.model is not set.
	DefaultDetectionModel = "GH_AW_DEFAULT_DETECTION_MODEL"

	// DefaultUTC is the enterprise override for the project home timezone used
	// when rendering local times in CLI output.
	DefaultUTC = "GH_AW_DEFAULT_UTC"

	// DefaultModelCopilot is the enterprise override for Copilot fallback model selection.
	DefaultModelCopilot = "GH_AW_DEFAULT_MODEL_COPILOT"
	// DefaultModelClaude is the enterprise override for Claude fallback model selection.
	DefaultModelClaude = "GH_AW_DEFAULT_MODEL_CLAUDE"
	// DefaultModelCodex is the enterprise override for Codex fallback model selection.
	DefaultModelCodex = "GH_AW_DEFAULT_MODEL_CODEX"
	// PolicyStrict enables runtime enforcement that workflows must be compiled in strict mode
	// when GH_AW_POLICY_STRICT is set to the string value "true".
	PolicyStrict = "GH_AW_POLICY_STRICT"
	// PolicyModelsAllowed applies experimental models.allowed policy from env.
	// It intersects with workflow models.allowed and does not change
	// models.blocked unless PolicyModelsBlocked is also set.
	PolicyModelsAllowed = "GHAW_POLICY_MODELS_ALLOWED"
	// PolicyModelsBlocked applies experimental models.blocked policy from env.
	// It unions with workflow models.blocked and does not change models.allowed
	// unless PolicyModelsAllowed is also set.
	PolicyModelsBlocked = "GHAW_POLICY_MODELS_BLOCKED"
	// PolicyAllowCreatePullRequest controls whether create-pull-request safe-outputs
	// remain runtime-compliant. Set to the string value "false" to disable the
	// create_pull_request safe-output tool at runtime.
	PolicyAllowCreatePullRequest = "GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST"
)

Functions

func BuildDefaultDetectionMaxAICreditsExpression

func BuildDefaultDetectionMaxAICreditsExpression(builtinDefault string) string

BuildDefaultDetectionMaxAICreditsExpression builds a vars expression that resolves the threat-detection max-ai-credits default at runtime from the GH_AW_DEFAULT_DETECTION_MAX_AI_CREDITS GitHub variable, falling back to builtinDefault when the variable is unset.

func BuildDefaultMaxAICreditsExpression

func BuildDefaultMaxAICreditsExpression(builtinDefault string) string

BuildDefaultMaxAICreditsExpression builds a vars expression that resolves max-ai-credits at runtime from the GH_AW_DEFAULT_MAX_AI_CREDITS GitHub variable, falling back to builtinDefault when the variable is unset. The expression is embedded in the compiled workflow and evaluated by the GitHub Actions runner.

func BuildDefaultMaxDailyAICreditsExpression

func BuildDefaultMaxDailyAICreditsExpression(builtinDefault string) string

BuildDefaultMaxDailyAICreditsExpression builds a vars expression that resolves max-daily-ai-credits at runtime from the GH_AW_DEFAULT_MAX_DAILY_AI_CREDITS GitHub variable, falling back to builtinDefault when the variable is unset.

func BuildDefaultMaxTurnsExpression

func BuildDefaultMaxTurnsExpression() string

BuildDefaultMaxTurnsExpression builds a vars expression that resolves max-turns at runtime from the GH_AW_DEFAULT_MAX_TURNS GitHub variable. An empty string is returned as the fallback so that an unset variable is treated as "no limit".

func BuildModelOverrideExpression

func BuildModelOverrideExpression(primaryVar, enterpriseDefaultVar, builtinFallback string) string

BuildModelOverrideExpression builds a vars expression with primary model var, enterprise default model var, and built-in fallback model.

func BuildModelOverrideExpressionEmptyFallback

func BuildModelOverrideExpressionEmptyFallback(primaryVar, enterpriseDefaultVar string) string

BuildModelOverrideExpressionEmptyFallback builds a vars expression with primary model var, enterprise default model var, and empty string fallback.

func ResolveDefaultDetectionModel

func ResolveDefaultDetectionModel(fallback string) string

ResolveDefaultDetectionModel is a convenience wrapper that delegates to the default process-environment Manager.

func ResolveDefaultMaxTurnCacheMisses

func ResolveDefaultMaxTurnCacheMisses(fallback int) int

ResolveDefaultMaxTurnCacheMisses is a convenience wrapper that delegates to the default process-environment Manager.

func ResolveDefaultMaxTurns

func ResolveDefaultMaxTurns(fallback string) string

ResolveDefaultMaxTurns is a convenience wrapper that delegates to the default process-environment Manager.

func ResolveDefaultTimeoutMinutes

func ResolveDefaultTimeoutMinutes(fallback int) int

ResolveDefaultTimeoutMinutes is a convenience wrapper that delegates to the default process-environment Manager.

func ResolveDefaultUTC

func ResolveDefaultUTC(fallback string) string

ResolveDefaultUTC is a convenience wrapper that delegates to the default process-environment Manager.

func ResolvePolicyModelsAllowed

func ResolvePolicyModelsAllowed() ([]string, bool)

ResolvePolicyModelsAllowed is a convenience wrapper that delegates to the default process-environment Manager.

func ResolvePolicyModelsBlocked

func ResolvePolicyModelsBlocked() ([]string, bool)

ResolvePolicyModelsBlocked is a convenience wrapper that delegates to the default process-environment Manager.

Types

type EnvGetter

type EnvGetter func(string) string

EnvGetter is a function type for looking up environment variables. It mirrors the signature of os.Getenv and is used to decouple library logic from direct process-environment access.

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager resolves enterprise env-var overrides through an injected EnvGetter. Construct one with New for explicit env control (e.g., in tests); package-level Resolve* convenience functions delegate to a default Manager backed by os.Getenv.

func New

func New(getenv EnvGetter) *Manager

New creates a Manager using the provided EnvGetter for environment lookups.

func (*Manager) ResolveDefaultDetectionModel

func (m *Manager) ResolveDefaultDetectionModel(fallback string) string

ResolveDefaultDetectionModel returns fallback when the env var is unset, otherwise returns the trimmed override value.

func (*Manager) ResolveDefaultMaxTurnCacheMisses

func (m *Manager) ResolveDefaultMaxTurnCacheMisses(fallback int) int

ResolveDefaultMaxTurnCacheMisses returns fallback when the env var is unset/invalid, otherwise returns the parsed override.

func (*Manager) ResolveDefaultMaxTurns

func (m *Manager) ResolveDefaultMaxTurns(fallback string) string

ResolveDefaultMaxTurns returns fallback when the env var is unset/invalid, otherwise returns the parsed override as a string.

func (*Manager) ResolveDefaultTimeoutMinutes

func (m *Manager) ResolveDefaultTimeoutMinutes(fallback int) int

ResolveDefaultTimeoutMinutes returns fallback when the env var is unset/invalid, otherwise returns the parsed override.

func (*Manager) ResolveDefaultUTC

func (m *Manager) ResolveDefaultUTC(fallback string) string

ResolveDefaultUTC returns fallback when the env var is unset, otherwise returns the trimmed override value.

func (*Manager) ResolvePolicyModelsAllowed

func (m *Manager) ResolvePolicyModelsAllowed() ([]string, bool)

ResolvePolicyModelsAllowed returns configured allowed model policy entries. When the env var is unset/empty, ok=false and callers should use frontmatter policy.

func (*Manager) ResolvePolicyModelsBlocked

func (m *Manager) ResolvePolicyModelsBlocked() ([]string, bool)

ResolvePolicyModelsBlocked returns configured blocked model policy entries. When the env var is unset/empty, ok=false and callers should use frontmatter policy.