Home Explore Blog CI



nixpkgs

pkgs/desktops/gnome/extensions/README.md
ced51490b3fb401f9a67042bf531635798cfc903fb2a3fa100000003000007eb
# GNOME Shell extensions

All 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.

## Automatically packaged extensions

The 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.

### Extensions updates

#### For everyday updates,

1. Run `update-extensions.py`.
2. Update `extensionRenames.nix` according to the comment at the top.

#### To package the extensions for new GNOME version,

1. Add a new `gnomeXYExtensions` set in `default.nix`.
2. Update `all-packages.nix` accordingly. (grep for `gnomeExtensions`)
3. Update `supported_versions` in `update-extensions.py`.
4. Follow the [For everyday updates](#for-everyday-updates) section.

#### For GNOME updates,

1. Follow the [To package the extensions for new GNOME version](#to-package-the-extensions-for-new-gnome-version) section if required.
2. Update `versions_to_merge` variable in `./update-extensions.py`.
3. Run `update-extensions.py --skip-fetch`, and update `extensionRenames.nix` according to the comment at the top.
4. Update `gnomeExtensions` in `default.nix` to the new versions.

## Manually packaged extensions

Manually 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.

Chunks
b04d9a01 (1st chunk of `pkgs/desktops/gnome/extensions/README.md`)
Title: GNOME Shell Extension Packaging
Summary
This section describes how GNOME Shell extensions are packaged in the system. Extensions are automatically packaged and can be found in `pkgs.gnomeXYExtensions`. `pkgs.gnomeExtensions` contains manually curated extensions. The process for updating extensions daily and for new GNOME versions is detailed, as well as how manually packaged extensions are handled.