config

package
v0.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateDir added in v0.1.3 

func CreateDir() error

CreateDir creates the config directory and all necessary parent directories missing. It returns any error it encounters with creating the directory.

func DirExists added in v0.1.3 

func DirExists() (bool, error)

DirExists returns a bool and error representing whether or not a config directory exists for the current user, and any errors it encounters with statting the existence of the directory.

func FileExists added in v0.1.3 

func FileExists() (bool, error)

FileExists returns a bool and error representing whether or not a config file exists for the current user, and any errors it encounters with statting the existence of the file.

Types

type Config 

type Config struct {
	ReleaseBranch string      `yaml:"release_branch"`
	Github        *GithubHost `yaml:"github.com"`
}

Config represents the config file for train

func New 

func New(tkn string) *Config

New takes a token string and creates the most basic config capable of being written.

func ParseFromFile 

func ParseFromFile() (*Config, error)

ParseFromFile reads the train config file from the home directory. It returns any errors it encounters with parsing the file.

func (*Config) WriteFile 

func (c *Config) WriteFile() error

WriteFile writes the file to the defined location for the current user, and returns any errors encountered doing so.

type GithubEnsures added in v0.2.0 

type GithubEnsures struct {
	Repos  []string `yaml:"repos"`
	Topics []string `yaml:"topics"`
}

type GithubHost added in v0.2.0 

type GithubHost struct {
	Token   string         `yaml:"token"`
	Ensures *GithubEnsures `yaml:"ensures"`
	Ignores *GithubIgnores `yaml:"ignores"`
	Limits  *Limits        `yaml:"limits"`
}

GithubHost represents a single host for which train has a configuration

type GithubIgnores added in v0.2.0 

type GithubIgnores struct {
	Repos  []string `yaml:"repos"`
	Topics []string `yaml:"topics"`
}

type Limits added in v0.2.0 

type Limits struct {
	RequestsPerSecond int `yaml:"request_per_second"`
	Burst             int `yaml:"burst"`
}

Limits represents a limits override for the client

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.