config

package
v1.2.1-beta.1 Latest Latest
Warning

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

Go to latest
Published: Aug 30, 2024 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const DefaultConfigPath = "~/.sauced.yaml"

Variables

This section is empty.

Functions

func GetConfigDirectory

func GetConfigDirectory() (string, error)

GetConfigDirectory gets the config directory path for the Pizza CLI. This function should be used to ensure consistency among commands for loading and modifying the config.

Types

type Spec

type Spec struct {

	// Attributions are mappings of GitHub usernames to a list of emails. These
	// emails should be the associated addresses used by individual GitHub users.
	// Example: { github_username: [ email1@domain.com, email2@domain.com ]} where
	// "github_username" has 2 emails attributed to them and their work.
	Attributions map[string][]string `yaml:"attribution"`
}

The configuration specification

func LoadConfig

func LoadConfig(path string, repoRootPathConfig string) (*Spec, error)

LoadConfig loads a configuration file at a given path. It attempts to load the default location of a ".sauced.yaml" in the user's home directory if an empty path is provided. If none is found in the user's home directory, it tries to load ".sauced.yaml" from the fallback path, which is the root path of a repository.

Jump to

Keyboard shortcuts

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