config

package
v2.39.2 Latest Latest
Warning

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

Go to latest
Published: Aug 6, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package config contains logic related to Devenv.yaml config

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ReadServiceName added in v2.19.0

func ReadServiceName() (string, error)

ReadServiceName reads service name from service.yaml

Types

type Devenv

type Devenv struct {
	// Service denotes if this repository is a service.
	Service bool `yaml:"service"`

	Dependencies struct {
		// Optional is a list of OPTIONAL services e.g. the service can run / gracefully function without it running
		Optional []string `yaml:"optional"`

		// Required is a list of services that this service cannot function without
		Required []string `yaml:"required"`
	} `yaml:"dependencies"`
}

Devenv is a struct that contains the devenv configuration which is usually called "devenv.yaml". This also works for the legacy service.yaml format.

func FromFile

func FromFile(confPath string) (*Devenv, error)

FromFile parses the devenv.yaml file and returns a DevenvConfig

func FromGitHub

func FromGitHub(ctx context.Context, conf *box.Config, serviceName string,
	gh *github.Client, configFileName string,
) (*Devenv, error)

FromGitHub reads and parses DevenvConfig from GitHub

func (*Devenv) GetAllDependencies

func (c *Devenv) GetAllDependencies() []string

getDependencies returns all dependencies

Jump to

Keyboard shortcuts

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