Skip to content
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.

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

Update gnome-initial-setup vendor configuration path #136

Merged
merged 4 commits into from
Dec 7, 2023

Conversation

wjt
Copy link
Member

@wjt wjt commented Dec 5, 2023

Previously we built GNOME Initial Setup to use the path
/var/lib/eos-image-defaults/branding/gnome-initial-setup.conf and
installed the keyfile specified in the [image] branding_fbe_config key
there. (There was no validation that its name was actually
gnome-initial-setup.conf, which was necessary for it to work.)

When we contributed this feature upstream to gnome-initial-setup, the
path was made configurable with a build-time parameter, with no default.

Some time later, Initial Setup started reading
/etc/gnome-initial-setup/vendor.conf if present; and
/usr/share/gnome-initial-setup/vendor.conf otherwise. It retained a
build-time parameter, which we continued to set; but setting that
parameter disabled both of the upstream paths.

With the upstream behaviour, it is possible to ship overrides in the
immutable bit of the OS, and further override them in /etc. This is in
my opinion preferable to what we have historically done, to
always write a file in /var for all images, even if the specific image
does not want any image-specific customisation of Initial Setup.

https://phabricator.endlessm.com/T35040

wjt added 4 commits December 5, 2023 10:25
This was introduced in 6740898 but
gnome-initial-setup upstream instead grew support for reading a list of
pages to skip from a keyfile, so in
c4af6b0 (also known as
endlessm/endless-image-config@f241f00)
this was removed everywhere except this hook.

https://phabricator.endlessm.com/T35040
Previously we built GNOME Initial Setup to use the path
/var/lib/eos-image-defaults/branding/gnome-initial-setup.conf and
installed the keyfile specified in the '[image] branding_fbe_config' key
there. (There was no validation that its name was actually
gnome-initial-setup.conf, which was necessary for it to work.)

When we contributed this feature upstream to gnome-initial-setup, the
path was made configurable with a build-time parameter, with no default.

Some time later, Initial Setup started reading
/etc/gnome-initial-setup/vendor.conf if present; and
/usr/share/gnome-initial-setup/vendor.conf otherwise. It retained a
build-time parameter, which we continued to set; but setting that
parameter disabled *both* of the upstream paths.

With the upstream behaviour, it is possible to ship overrides in the
immutable bit of the OS, and further override them in /etc. This is in
my opinion preferable to what we have historically done, to
always write a file in /var for all images, even if the specific image
does not want any image-specific customisation of Initial Setup.

Install any config file to the upstream path in /etc, matching a build
configuration change I will make in our gnome-initial-setup package.

https://phabricator.endlessm.com/T35040
This will instead be installed by eos-theme, to a location in /usr.

https://phabricator.endlessm.com/T35040
@wjt wjt marked this pull request as ready for review December 5, 2023 11:18
Copy link
Member

@dbnicholson dbnicholson left a comment

Choose a reason for hiding this comment

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

Looks good. I'll wait on merging this until the g-i-s PRs are ready.

@wjt
Copy link
Member Author

wjt commented Dec 7, 2023

I'm going to go ahead and merge this because the vanilla Debian copy of gnome-initial-setup we have in eos:master:core already uses the upstream paths.

@wjt wjt merged commit 0ecd4e0 into master Dec 7, 2023
2 checks passed
@wjt wjt deleted the T35040-initial-setup-vendor-conf-path branch December 7, 2023 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants