config

Documentation

Overview

config holds all the required Types and Functions to work with the Changelog-Go Configuration File

Index

• type V1
  • func (c *V1) Check() error

Types

type V1

type V1 struct {
	PreRelease struct {
		// detect pre-releases or not
		Detect           bool `yaml:"detect"`
		DeletePreRelease bool `yaml:"deletePreRelease"` // if true the pre-releases would be deleted on an non pre-release
		FoldPreReleases  bool `yaml:"foldPreReleases"`
	} `yaml:"preRelease"`

	Entry struct {
		Author rune `yaml:"author"`
	} `yaml:"entry"`

	Changelog struct {
		// Changelog Path where changelog-go will save all the Entries.
		// Will be changed to a relative path after calling Check()
		EntryPath string `yaml:"entryPath"`
		Changelog string `yaml:"changelog"`
	} `yaml:"changelog"`
}

V1 represents the Config Version 1. Versioning the Config Types is to provide Backward compatibility.

func (*V1) Check

func (c *V1) Check() error

Check will test if all required Paths and files are represent and if not it will TRY to create them. If an Error occurs while creating those Files/ Dirs Check() will return the Error.