checkupgrade

package
v2.932.10 Latest Latest
Warning

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

Go to latest
Published: Aug 20, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package checkupgrade provides functionality to compare a gen.yaml configuration against the defaults for new SDKs, identifying which settings differ from the recommended defaults.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FindGenYaml

func FindGenYaml(repoPath string) string

FindGenYaml locates the gen.yaml file in a repository

func FindTargets

func FindTargets(genConfig map[string]any) []string

FindTargets returns the language targets configured in a gen.yaml

func FormatValue

func FormatValue(v any) string

FormatValue formats a value for display

Types

type ConfigDifference

type ConfigDifference struct {
	Key          string
	CurrentValue any
	NewSDKValue  any
	Description  string
}

ConfigDifference represents a single configuration value that differs from the newSDK default

type Options

type Options struct {
	IncludeMatches bool // Include matching values in results
}

Options configures the check-upgrade behavior

type Result

type Result struct {
	GenYamlPath string
	Generation  *SectionResult
	Languages   map[string]*SectionResult
}

Result contains the full comparison results

func Check

func Check(repoPath string, opts Options) (*Result, error)

Check analyzes a gen.yaml file and compares it against newSDK defaults

type SectionResult

type SectionResult struct {
	Name        string
	Differences []ConfigDifference
	Matches     []ConfigDifference // Only populated when IncludeMatches is true
}

SectionResult contains the comparison results for a configuration section

Jump to

Keyboard shortcuts

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