Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

godotyaml

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 30, 2026

Changes in this version

type Document

+ func New(m Metadata, omitDefaults bool) *Document

+ func (d *Document) MergeExternalConfig(name string, value any) error

+ func (d *Document) RemoveExternalConfig(name string) bool

+ func (d *Document) RemoveExternalConfigKey(name, key string) bool

+ func (d *Document) SaveNew(path string) error

+ func (d *Document) SetExternalConfigKey(name, key string, value any) error

+ type Metadata struct

+ Authors []Author

+ Description string

+ Documentation string

+ Executables Executables

+ Homepage string

+ IssueTracker string

+ License string

+ Name string

+ Repository string

+ SchemaVersion int

+ Version string

v0.1.0

May 23, 2026

Changes in this version

+ type Author struct

+ Email string

+ Name string

+ Organization string

+ URL string

+ type Document struct

+ Doc *yaml.Node

+ Root *yaml.Node

+ func Load(path string) (*Document, error)

+ func Parse(r io.Reader) (*Document, error)

+ func (d *Document) Authors() ([]Author, error)

+ func (d *Document) DecodeExternalConfig(name string, out any) (bool, error)

+ func (d *Document) Description() string

+ func (d *Document) Documentation() string

+ func (d *Document) Executables() (Executables, error)

+ func (d *Document) ExternalConfigNames() []string

+ func (d *Document) GetRawExternalConfig(name string) (*yaml.Node, bool)

+ func (d *Document) Homepage() string

+ func (d *Document) IssueTracker() string

+ func (d *Document) License() string

+ func (d *Document) Name() string

+ func (d *Document) Repository() string

+ func (d *Document) Save(path string) error

+ func (d *Document) SchemaVersion() (int, error)

+ func (d *Document) SetExternalConfig(name string, value any) error

+ func (d *Document) Version() string

+ func (d *Document) Write(w io.Writer) error

+ type Executable struct

+ Description string

+ Entrypoint string

+ type Executables map[string]Executable