Overwrite config files by default
We are going to make a big behavior change in GDK that we expect to be a net benefit for most if not all GDK users.
When GDK was made we assumed the user (the developer) manages all the GitLab config files and we only set up the config files once, when GDK is installed. Over time this has become more and more annoying because config files need changes over time as GitLab changes, and if you don't manually make those config file changes, your GDK can break.
We now have a system where GDK warns you during gdk update
if one of your config files (such as gitlab/config/gitlab.yml
) is out of date. This is not great because most users will want to just apply the latest config files and now they have to do manual steps.
What we are going to change by the end of February is that the default behavior becomes for GDK to overwrite all config files when necessary (except gdk.yml
). If a user does not want that, they can put an exception in gdk.yml
.
gdk:
protected_config_files:
# protect gitlab/config/gitlab.yml
- gitlab/config/gitlab.yml
These exceptions support wildcards. If you want to protect all config files, use '*'
.
If you want to test-drive the new behavior before it becomes the default, put the following in gdk.yml
:
gdk:
# Empty array means GDK is allowed to overwrite any config file it wants.
protected_config_files: []