Skip to content

Check if configuration is valid prior to attempting migration #4334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Check if configuration is valid prior to attempting migration #4334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions pkg/config/app_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,15 +191,25 @@ func loadUserConfig(configFiles []*ConfigFile, base *UserConfig) (*UserConfig, e
return nil, err
}

content, err = migrateUserConfig(path, content)
existingCustomCommands := base.CustomCommands
Copy link
Contributor Author

@ChrisMcD1 ChrisMcD1 Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line needs to be before we make any potential modifications to base , so I have just moved it fully before the parsing.


var node yaml.Node
err = yaml.Unmarshal(content, &node)
if err != nil {
return nil, err
return nil, fmt.Errorf("Failed to parse config at `%s` as YAML document. Please check your file before opening an issue\n %w", path, err)
}

existingCustomCommands := base.CustomCommands

if err := yaml.Unmarshal(content, base); err != nil {
return nil, fmt.Errorf("The config at `%s` couldn't be parsed, please inspect it before opening up an issue.\n%w", path, err)
err = node.Decode(base)
if err != nil {
// We attempt to migrate the configuration, and then re-attempt to unmarshal
content, err = migrateUserConfig(path, content)
if err != nil {
return nil, err
}
err = yaml.Unmarshal(content, base)
if err != nil {
return nil, fmt.Errorf("Failed to decode config at path `%s` after attempting auto-migration. Please check your file before opening an issue\n %w", path, err)
}
}

base.CustomCommands = append(base.CustomCommands, existingCustomCommands...)
Expand Down
Loading