Method ReadConfig

pkg/ddevapp/config.go:362–418

ReadConfig reads project configuration from the config.yaml file It does not attempt to set default values; that's NewApp's job. returns the list of config files read

(includeOverrides bool)

// It does not attempt to set default values; that's NewApp's job.
// returns the list of config files read
func (app *DdevApp) ReadConfig(includeOverrides bool) ([]string, error) {
	if app.ConfigPath == "" {
		app.ConfigPath = app.GetConfigPath("config.yaml")
	}

	configOverrides := []string{}
	var err error
	// Load config.*.y*ml after in glob order
	if includeOverrides {
		glob := filepath.Join(filepath.Dir(app.ConfigPath), "config.*.y*ml")
		configOverrides, err = filepath.Glob(glob)
		if err != nil {
			return []string{}, err
		}
	}

	allFiles := append([]string{app.ConfigPath}, configOverrides...)
	fileContents := make(map[string][]byte)

	// Add Pre-Load Validation (Hook Checks)
	for _, file := range allFiles {
		source, err := os.ReadFile(file)
		if err != nil {
			return []string{}, fmt.Errorf("unable to read config file %s: %v", file, err)
		}
		err = validateHookYAML(source)
		if err != nil {
			return []string{}, fmt.Errorf("invalid configuration in %s: %v", file, err)
		}
		fileContents[file] = source
	}

	// Sort WebExtraExposedPorts so the entry matching configured router ports comes first
	SortWebExtraExposedPorts(app)

	// Determine overrides and their contents in correct order
	var overrides []settings.OverrideConfig
	var overrideKeys []string
	for _, f := range configOverrides {
		if f != app.ConfigPath {
			overrides = append(overrides, settings.OverrideConfig{
				Path:    f,
				Content: fileContents[f],
			})
			overrideKeys = append(overrideKeys, f)
		}
	}

	err = settings.LoadProjectConfigFromContents(fileContents[app.ConfigPath], overrides, app)
	if err != nil {
		return []string{}, fmt.Errorf("failed to load project config: %v", err)
	}

	app.ConfigPostLoadCleanup()

	return append([]string{app.ConfigPath}, overrideKeys...), nil
}