config

package

v0.3.0 Latest Latest Go to latest Published: Mar 21, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/monkescience/yeet

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config handles parsing and validation of .yeet.yaml configuration files.

Constants ¶

View Source

const DefaultFile = ".yeet.yaml"

View Source

const DefaultSchemaURL = "https://raw.githubusercontent.com/monkescience/yeet/main/yeet.schema.json"

View Source

const SchemaDirective = "# yaml-language-server: $schema=" + DefaultSchemaURL

Variables ¶

View Source

var ErrInvalidConfig = errors.New("invalid config")

Functions ¶

This section is empty.

Types ¶

type AutoMergeMethod ¶ added in v0.1.2

type AutoMergeMethod = string

const (
	AutoMergeMethodAuto   AutoMergeMethod = "auto"
	AutoMergeMethodSquash AutoMergeMethod = "squash"
	AutoMergeMethodRebase AutoMergeMethod = "rebase"
	AutoMergeMethodMerge  AutoMergeMethod = "merge"
)

type CalVerConfig ¶

type CalVerConfig struct {
	Format string `yaml:"format"`
}

type ChangelogConfig ¶

type ChangelogConfig struct {
	File     string            `yaml:"file"`
	Include  []string          `yaml:"include"`
	Sections map[string]string `yaml:"sections"`
}

type Config ¶

type Config struct {
	Versioning   VersioningStrategy `yaml:"versioning"`
	Branch       string             `yaml:"branch"`
	Provider     ProviderType       `yaml:"provider"`
	TagPrefix    string             `yaml:"tag_prefix"`
	Repository   RepositoryConfig   `yaml:"repository"`
	VersionFiles []string           `yaml:"version_files,omitempty"`
	Release      ReleaseConfig      `yaml:"release"`
	Changelog    ChangelogConfig    `yaml:"changelog"`
	CalVer       CalVerConfig       `yaml:"calver"`
}

func Default ¶

func Default() *Config

func Load ¶

func Load(path string) (*Config, error)

func Parse ¶

func Parse(data []byte) (*Config, error)

func (*Config) Validate ¶

func (c *Config) Validate() error

type ProviderType ¶

type ProviderType = string

const (
	ProviderAuto   ProviderType = "auto"
	ProviderGitHub ProviderType = "github"
	ProviderGitLab ProviderType = "gitlab"
)

type ReleaseConfig ¶

type ReleaseConfig struct {
	SubjectIncludeBranch bool            `yaml:"subject_include_branch"`
	AutoMerge            bool            `yaml:"auto_merge"`
	AutoMergeForce       bool            `yaml:"auto_merge_force"`
	AutoMergeMethod      AutoMergeMethod `yaml:"auto_merge_method"`
	PRBodyHeader         string          `yaml:"pr_body_header"`
	PRBodyFooter         string          `yaml:"pr_body_footer"`
}

type RepositoryConfig ¶ added in v0.1.3

type RepositoryConfig struct {
	Remote  string `yaml:"remote"`
	Host    string `yaml:"host"`
	Owner   string `yaml:"owner"`
	Repo    string `yaml:"repo"`
	Project string `yaml:"project"`
}

type VersioningStrategy ¶

type VersioningStrategy = string

const (
	// VersioningSemver uses semantic versioning (MAJOR.MINOR.PATCH).
	VersioningSemver VersioningStrategy = "semver"
	// VersioningCalVer uses calendar versioning (e.g., YYYY.0M.MICRO).
	VersioningCalVer VersioningStrategy = "calver"
)

Source Files ¶

View all Source files

config.go

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