build

package

v0.0.0-...-ad80bd6 Latest Latest Go to latest Published: Jan 19, 2026 License: MIT Imports: 9 Imported by: 0

Documentation ¶

This section is empty.

This section is empty.

func BuildDeprecations() error

func BuildFeatureFlags() error

func BuildPageMetadata() error

func BuildRedirects() error

BuildRedirects generates the GitLab Pages _redirects file from the YAML source.

func CleanupExistingFile(filepath string) error

Removes a file if it already exists

func CreateDirectory(dir string) error

Creates a directory if it doesn't exist

func ReadYAMLFile(filename string, out interface{}) error

Read and parse a YAML file into the provided interface

func WriteBuildFile(filename string, data []byte) error

Write a file that we've created in the build stage

type BuildFileManager struct {
	OutputPath string
	DataDir    string
}

func NewBuildFileManager(filename string) *BuildFileManager

func (dm *BuildFileManager) PrepareAndWrite(data []byte) error

type Metatags struct {
	Section     string `json:"section"`
	TrailString string `json:"trail_string"`
}

type NavItem struct {
	Title   string    `yaml:"title"`
	URL     string    `yaml:"url"`
	Submenu []NavItem `yaml:"submenu,omitempty"`
}

type PageMetadata struct {
	Metatags   Metatags    `json:"metatags"`
	TrailItems []TrailItem `json:"trail_items"`
}

type Redirect struct {
	From       string `yaml:"from"`
	To         string `yaml:"to"`
	RemoveDate string `yaml:"remove_date,omitempty"`
}

Redirect represents a single redirect entry in the YAML file.

type RedirectsFile struct {
	Redirects []Redirect `yaml:"redirects"`
}

RedirectsFile represents the structure of the redirects YAML file.

type TrailItem struct {
	Title string `json:"title"`
	Path  string `json:"path"`
}