config

package
v1.75.0 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2025 License: MIT Imports: 18 Imported by: 0

README

stage: Create group: Code Review info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Add a new configuration

To add a new configuration to config.yaml.lock:

  1. Add a head comment and a default value:

    # head comment
new_key: default_value

  2. Add any configuration that is specific to a hostname or GitLab instance to the hosts section, in the gitlab.com subsection:

    ...
# This configuration is specifically for GitLab instances
hosts:
  gitlab.com:
    ...
    # This is a new config
    new_key: default_value
...

  3. Add general configuration changes before the hosts section:

    ...
# Head comment
new_key: default_value
# Configuration specific for GitLab instances
hosts:
  gitlab.com:
...

  4. Run make gen-config or cd internal/config && go generate.

  5. Most configuration keys can be overwritten by their corresponding environment variables. If the corresponding environment variable name differs from the configuration key's name, set the environment variable's name in the config_mapping.go file.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BackupConfigFile = func(filename string) error {
	return os.Rename(filename, filename+".bak")
}

BackupConfigFile creates a backup of the provided config file

View Source 
var LocalConfigDir = func() []string {
	return append(GitDir(true), "glab-cli")
}

LocalConfigDir returns the local config path in map which must be joined for complete path

View Source 
var LocalConfigFile = func() string {
	configFile := append(LocalConfigDir(), "config.yml")
	return filepath.Join(configFile...)
}

LocalConfigFile returns the config file name with full path

View Source 
var ReadConfigFile = func(filename string) ([]byte, error) {
	data, err := os.ReadFile(filename)
	if err != nil {
		return nil, pathError(err)
	}

	return data, nil
}
View Source 
var WriteConfigFile = func(filename string, data []byte) error {
	err := os.MkdirAll(path.Dir(filename), 0o750)
	if err != nil {
		return pathError(err)
	}
	_, err = os.ReadFile(filename)
	if err != nil && !os.IsNotExist(err) {
		return err
	}
	err = WriteFile(filename, data, 0o600)
	return err
}

Functions

func CheckFileExists 

func CheckFileExists(filename string) bool

CheckFileExists: checks if a file exists and is not a directory.

func CheckPathExists 

func CheckPathExists(path string) bool

CheckPathExists checks if a folder exists and is a directory

func ConfigDir 

func ConfigDir() string

ConfigDir returns the config directory for writing configuration. It respects GLAB_CONFIG_DIR as the highest priority override, otherwise uses XDG_CONFIG_HOME (defaulting to ~/.config).

func ConfigFile 

func ConfigFile() string

ConfigFile returns the config file path. It respects GLAB_CONFIG_DIR as the highest priority override, otherwise returns the XDG-compliant user config file path. This function only determines the path without creating directories.

func ConfigKeyEquivalence 

func ConfigKeyEquivalence(key string) string

ConfigKeyEquivalence returns the equivalent key that's actually used in the config file

func EnvKeyEquivalence 

func EnvKeyEquivalence(key string) []string

EnvKeyEquivalence returns the equivalent key that's used for environment variables

func GetFromEnv 

func GetFromEnv(key string) string

GetFromEnv is just a wrapper for os.GetEnv but checks for matching names used in previous glab versions and retrieves the value of the environment if any of the matching names have been set. It returns the value, which will be empty if the variable is not present.

func GetFromEnvWithSource 

func GetFromEnvWithSource(key string) (string, string)

GetFromEnvWithSource works like GetFromEnv but also returns the name of the environment variable that was set as the source.

func GitDir added in v1.59.0 

func GitDir(preferRelative bool) []string

for later use we might prefer relative paths GitDir will find a directory or just return ".git"

func HasSecurePerms added in v1.44.0 

func HasSecurePerms(m fs.FileMode) bool

func NewBlankRoot 

func NewBlankRoot() *yaml.Node

func ParseConfigFile added in v1.29.0 

func ParseConfigFile(filename string) ([]byte, *yaml.Node, error)

func ResolveCustomHeaders added in v1.73.1 

func ResolveCustomHeaders(cfg Config, hostname string) (map[string]string, error)

ResolveCustomHeaders is a helper function that works with the Config interface

func SearchConfigFile added in v1.75.0 

func SearchConfigFile() (string, error)

SearchConfigFile searches for an existing config file across all XDG config paths. It respects GLAB_CONFIG_DIR as the highest priority override. Search order: 1. $GLAB_CONFIG_DIR/config.yml (if GLAB_CONFIG_DIR is set) 2. $XDG_CONFIG_HOME/glab-cli/config.yml (default: ~/.config/glab-cli/config.yml) 3. $XDG_CONFIG_DIRS/glab-cli/config.yml (default: /etc/xdg/glab-cli/config.yml)

Returns the path to the first config file found, or an error if none exist.

func StubConfig 

func StubConfig(main, aliases string) func()

func StubWriteConfig 

func StubWriteConfig(wc io.Writer, wh io.Writer) func()

func TrimmedFileContents added in v1.54.0 

func TrimmedFileContents(filePath string) (string, error)

func WriteFile 

func WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile to the path If the path is smylink it will write to the symlink

Types

type AliasConfig 

type AliasConfig struct {
	ConfigMap
	Parent Config
}

func (*AliasConfig) All 

func (a *AliasConfig) All() map[string]string

func (*AliasConfig) Delete 

func (a *AliasConfig) Delete(alias string) error

func (*AliasConfig) Get 

func (a *AliasConfig) Get(alias string) (string, bool)

func (*AliasConfig) Set 

func (a *AliasConfig) Set(alias, expansion string) error

func (*AliasConfig) Write 

func (a *AliasConfig) Write() error

type Config 

type Config interface {
	Get(string, string) (string, error)
	GetWithSource(string, string, bool) (string, string, error)
	Set(string, string, string) error
	Hosts() ([]string, error)
	Aliases() (*AliasConfig, error)
	Local() (*LocalConfig, error)
	// Write writes to the config.yml file
	Write() error
	// WriteAll saves all the available configuration file types
	WriteAll() error
}

A Config reads and writes persistent configuration for glab.

func Init 

func Init() (Config, error)

Init initialises and returns the cached configuration

func NewBlankConfig 

func NewBlankConfig() Config

NewBlankConfig initializes a config file pre-populated with comments and default values

func NewConfig 

func NewConfig(root *yaml.Node) Config

func NewFromString 

func NewFromString(str string) Config

NewFromString initializes a Config from a yaml string

func ParseConfig 

func ParseConfig(filename string) (Config, error)

func ParseDefaultConfig 

func ParseDefaultConfig() (Config, error)

type ConfigEntry 

type ConfigEntry struct {
	KeyNode   *yaml.Node
	ValueNode *yaml.Node
	Index     int
}

type ConfigMap 

type ConfigMap struct {
	Root *yaml.Node
}

ConfigMap type implements a low-level get/set config that is backed by an in-memory tree of YAML nodes. It allows us to interact with a YAML-based config programmatically, preserving any comments that were present when the YAML was parsed.

func (*ConfigMap) Empty 

func (cm *ConfigMap) Empty() bool

func (*ConfigMap) FindEntry 

func (cm *ConfigMap) FindEntry(key string) (*ConfigEntry, error)

func (*ConfigMap) GetStringValue 

func (cm *ConfigMap) GetStringValue(key string) (string, error)

func (*ConfigMap) RemoveEntry 

func (cm *ConfigMap) RemoveEntry(key string)

func (*ConfigMap) SetStringValue 

func (cm *ConfigMap) SetStringValue(key, value string) error

type CustomHeader added in v1.73.1 

type CustomHeader struct {
	Name         string `yaml:"name"`
	Value        string `yaml:"value,omitempty"`
	ValueFromEnv string `yaml:"valueFromEnv,omitempty"`
}

CustomHeader represents a single custom HTTP header configuration

func (*CustomHeader) ResolvedValue added in v1.73.1 

func (h *CustomHeader) ResolvedValue() (string, error)

ResolvedValue returns the actual header value, resolving environment variables if needed

type HostConfig 

type HostConfig struct {
	ConfigMap
	Host string
}

HostConfig represents the configuration for a single host.

func (*HostConfig) GetCustomHeaders added in v1.73.1 

func (hc *HostConfig) GetCustomHeaders() ([]CustomHeader, error)

GetCustomHeaders returns the custom headers for a specific host

type LocalConfig 

type LocalConfig struct {
	ConfigMap
	Parent Config
}

func (*LocalConfig) All 

func (a *LocalConfig) All() map[string]string

func (*LocalConfig) Delete 

func (a *LocalConfig) Delete(key string) error

func (*LocalConfig) Get 

func (a *LocalConfig) Get(key string) (string, bool)

func (*LocalConfig) Set 

func (a *LocalConfig) Set(key, value string) error

func (*LocalConfig) Write 

func (a *LocalConfig) Write() error

type NotFoundError 

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

NotFoundError is returned when a config entry is not found.

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.