tjh.dev
1# GNOME Shell extensions
2
3All extensions are packaged automatically. They can be found in the `pkgs.gnomeXYExtensions` for XY being a GNOME version. The package names are the extension’s UUID, which can be a bit unwieldy to use. `pkgs.gnomeExtensions` is a set of manually curated extensions that match the current `pkgs.gnome-shell` versions. Their name is human-friendly, compared to the other extensions sets. Some of its extensions are manually packaged.
4
5## Automatically packaged extensions
6
7The actual packages are created by `buildGnomeExtension.nix`, provided the correct arguments are fed into it. The important extension data is stored in `extensions.json`, one line/item per extension. That file is generated by running `update-extensions.py`. Furthermore, the automatic generated names are dumped in `collisions.json` for manual inspection. `extensionRenames.nix` contains new names for all extensions that collide.
8
9### Extensions updates
10
11#### For everyday updates,
12
131. Run `update-extensions.py`.
142. Update `extensionRenames.nix` according to the comment at the top.
15
16#### To package the extensions for new GNOME version,
17
181. Add a new `gnomeXYExtensions` set in `default.nix`.
192. Update `all-packages.nix` accordingly. (grep for `gnomeExtensions`)
203. Update `supported_versions` in `update-extensions.py`.
214. Follow the [For everyday updates](#for-everyday-updates) section.
22
23#### For GNOME updates,
24
251. Follow the [To package the extensions for new GNOME version](#to-package-the-extensions-for-new-gnome-version) section if required.
262. Update `versions_to_merge` variable in `./update-extensions.py`.
273. Run `update-extensions.py --skip-fetch`, and update `extensionRenames.nix` according to the comment at the top.
284. Update `gnomeExtensions` in `default.nix` to the new versions.
29
30## Manually packaged extensions
31
32Manually packaged extensions overwrite some of the automatically packaged ones in `pkgs.gnomeExtensions`. They are listed in `manuallyPackaged.nix`, every extension has its own sub-folder.