commit 1d85557b5025a67d94d31c3c0508253c26b90f07 · pyrox.dev/nixpkgs

-1

doc/build-helpers/images.md

···

       6
       6
        
       images/appimagetools.section.md

     

       7
       7
        
       images/dockertools.section.md

     

       8
       8
        
       images/ocitools.section.md

     

       9
       9
       -
       images/snaptools.section.md

     

       10
       9
        
       images/portableservice.section.md

     

       11
       10
        
       images/makediskimage.section.md

     

       12
       11
        
       images/binarycache.section.md

-71

doc/build-helpers/images/snaptools.section.md

···

       1
       1
       -
       # pkgs.snapTools {#sec-pkgs-snapTools}

     

       2
       2
       -
       

     

       3
       3
       -
       `pkgs.snapTools` is a set of functions for creating Snapcraft images. Snap and Snapcraft is not used to perform these operations.

     

       4
       4
       -
       

     

       5
       5
       -
       ## The makeSnap Function {#ssec-pkgs-snapTools-makeSnap-signature}

     

       6
       6
       -
       

     

       7
       7
       -
       `makeSnap` takes a single named argument, `meta`. This argument mirrors [the upstream `snap.yaml` format](https://docs.snapcraft.io/snap-format) exactly.

     

       8
       8
       -
       

     

       9
       9
       -
       The `base` should not be specified, as `makeSnap` will force set it.

     

       10
       10
       -
       

     

       11
       11
       -
       Currently, `makeSnap` does not support creating GUI stubs.

     

       12
       12
       -
       

     

       13
       13
       -
       ## Build a Hello World Snap {#ssec-pkgs-snapTools-build-a-snap-hello}

     

       14
       14
       -
       

     

       15
       15
       -
       The following expression packages GNU Hello as a Snapcraft snap.

     

       16
       16
       -
       

     

       17
       17
       -
       ``` {#ex-snapTools-buildSnap-hello .nix}

     

       18
       18
       -
       let

     

       19
       19
       -
         inherit (import <nixpkgs> { }) snapTools hello;

     

       20
       20
       -
       in snapTools.makeSnap {

     

       21
       21
       -
         meta = {

     

       22
       22
       -
           name = "hello";

     

       23
       23
       -
           summary = hello.meta.description;

     

       24
       24
       -
           description = hello.meta.longDescription;

     

       25
       25
       -
           architectures = [ "amd64" ];

     

       26
       26
       -
           confinement = "strict";

     

       27
       27
       -
           apps.hello.command = "${hello}/bin/hello";

     

       28
       28
       -
         };

     

       29
       29
       -
       }

     

       30
       30
       -
       ```

     

       31
       31
       -
       

     

       32
       32
       -
       `nix-build` this expression and install it with `snap install ./result --dangerous`. `hello` will now be the Snapcraft version of the package.

     

       33
       33
       -
       

     

       34
       34
       -
       ## Build a Graphical Snap {#ssec-pkgs-snapTools-build-a-snap-firefox}

     

       35
       35
       -
       

     

       36
       36
       -
       Graphical programs require many more integrations with the host. This example uses Firefox as an example because it is one of the most complicated programs we could package.

     

       37
       37
       -
       

     

       38
       38
       -
       ``` {#ex-snapTools-buildSnap-firefox .nix}

     

       39
       39
       -
       let

     

       40
       40
       -
         inherit (import <nixpkgs> { }) snapTools firefox;

     

       41
       41
       -
       in snapTools.makeSnap {

     

       42
       42
       -
         meta = {

     

       43
       43
       -
           name = "nix-example-firefox";

     

       44
       44
       -
           summary = firefox.meta.description;

     

       45
       45
       -
           architectures = [ "amd64" ];

     

       46
       46
       -
           apps.nix-example-firefox = {

     

       47
       47
       -
             command = "${firefox}/bin/firefox";

     

       48
       48
       -
             plugs = [

     

       49
       49
       -
               "pulseaudio"

     

       50
       50
       -
               "camera"

     

       51
       51
       -
               "browser-support"

     

       52
       52
       -
               "avahi-observe"

     

       53
       53
       -
               "cups-control"

     

       54
       54
       -
               "desktop"

     

       55
       55
       -
               "desktop-legacy"

     

       56
       56
       -
               "gsettings"

     

       57
       57
       -
               "home"

     

       58
       58
       -
               "network"

     

       59
       59
       -
               "mount-observe"

     

       60
       60
       -
               "removable-media"

     

       61
       61
       -
               "x11"

     

       62
       62
       -
             ];

     

       63
       63
       -
           };

     

       64
       64
       -
           confinement = "strict";

     

       65
       65
       -
         };

     

       66
       66
       -
       }

     

       67
       67
       -
       ```

     

       68
       68
       -
       

     

       69
       69
       -
       `nix-build` this expression and install it with `snap install ./result --dangerous`. `nix-example-firefox` will now be the Snapcraft version of the Firefox package.

     

       70
       70
       -
       

     

       71
       71
       -
       The specific meaning behind plugs can be looked up in the [Snapcraft interface documentation](https://docs.snapcraft.io/supported-interfaces).

-4

pkgs/build-support/snap/default.nix

···

       1
       1
       -
       { callPackage, hello }:

     

       2
       2
       -
       {

     

       3
       3
       -
         makeSnap = callPackage ./make-snap.nix { };

     

       4
       4
       -
       }

-84

pkgs/build-support/snap/make-snap.nix

···

       1
       1
       -
       {

     

       2
       2
       -
         runCommand, squashfsTools, closureInfo, lib, jq, writeText

     

       3
       3
       -
       }:

     

       4
       4
       -
       

     

       5
       5
       -
       {

     

       6
       6
       -
         # The meta parameter is the contents of the `snap.yaml`, NOT the

     

       7
       7
       -
         # `snapcraft.yaml`.

     

       8
       8
       -
         #

     

       9
       9
       -
         # - `snap.yaml` is what is inside of the final Snap,

     

       10
       10
       -
         # - `snapcraft.yaml` is used by `snapcraft` to build snaps

     

       11
       11
       -
         #

     

       12
       12
       -
         # Since we skip the `snapcraft` tool, we skip the `snapcraft.yaml`

     

       13
       13
       -
         # file. For more information:

     

       14
       14
       -
         #

     

       15
       15
       -
         #   https://docs.snapcraft.io/snap-format

     

       16
       16
       -
         #

     

       17
       17
       -
         # Note: unsquashfs'ing an existing snap from the store can be helpful

     

       18
       18
       -
         # for determining what you you're missing.

     

       19
       19
       -
         #

     

       20
       20
       -
         meta

     

       21
       21
       -
       }: let

     

       22
       22
       -
           snap_yaml = let

     

       23
       23
       -
             # Validate the snap's meta contains a name.

     

       24
       24
       -
             # Also: automatically set the `base` parameter and the layout for

     

       25
       25
       -
             # the `/nix` bind.

     

       26
       26
       -
             validate = { name, ... } @ args:

     

       27
       27
       -
               args // {

     

       28
       28
       -
                 # Combine the provided arguments with the required options.

     

       29
       29
       -
       

     

       30
       30
       -
                 # base: built from https://github.com/NixOS/snapd-nix-base

     

       31
       31
       -
                 # and published as The NixOS Foundation on the Snapcraft store.

     

       32
       32
       -
                 base = "nix-base";

     

       33
       33
       -
                 layout = (args.layout or {}) // {

     

       34
       34
       -
                   # Bind mount the Snap's root nix directory to `/nix` in the

     

       35
       35
       -
                   # execution environment's filesystem namespace.

     

       36
       36
       -
                   "/nix".bind = "$SNAP/nix";

     

       37
       37
       -
                 };

     

       38
       38
       -
               };

     

       39
       39
       -
           in writeText "snap.yaml"

     

       40
       40
       -
             (builtins.toJSON (validate meta));

     

       41
       41
       -
       

     

       42
       42
       -
         # These are specifically required by snapd, so don't change them

     

       43
       43
       -
         # unless you've verified snapcraft / snapd can handle them. Best bet

     

       44
       44
       -
         # is to just mirror this list against how snapcraft creates images.

     

       45
       45
       -
         # from: https://github.com/snapcore/snapcraft/blob/b88e378148134383ffecf3658e3a940b67c9bcc9/snapcraft/internal/lifecycle/_packer.py#L96-L98

     

       46
       46
       -
         mksquashfs_args = [

     

       47
       47
       -
           "-noappend" "-comp" "xz" "-no-xattrs" "-no-fragments"

     

       48
       48
       -
       

     

       49
       49
       -
           # Note: We want -all-root every time, since all the files are

     

       50
       50
       -
           # owned by root anyway. This is true for Nix, but not true for

     

       51
       51
       -
           # other builds.

     

       52
       52
       -
           # from: https://github.com/snapcore/snapcraft/blob/b88e378148134383ffecf3658e3a940b67c9bcc9/snapcraft/internal/lifecycle/_packer.py#L100

     

       53
       53
       -
           "-all-root"

     

       54
       54
       -
         ];

     

       55
       55
       -
       

     

       56
       56
       -
       in runCommand "squashfs.img" {

     

       57
       57
       -
         nativeBuildInputs = [ squashfsTools jq ];

     

       58
       58
       -
       

     

       59
       59
       -
         closureInfo = closureInfo {

     

       60
       60
       -
           rootPaths = [ snap_yaml ];

     

       61
       61
       -
         };

     

       62
       62
       -
       } ''

     

       63
       63
       -
         root=$PWD/root

     

       64
       64
       -
         mkdir $root

     

       65
       65
       -
       

     

       66
       66
       -
         (

     

       67
       67
       -
           # Put the snap.yaml in to `/meta/snap.yaml`, setting the version

     

       68
       68
       -
           # to the hash part of the store path

     

       69
       69
       -
           mkdir $root/meta

     

       70
       70
       -
           version=$(echo $out | cut -d/ -f4 | cut -d- -f1)

     

       71
       71
       -
           cat ${snap_yaml} | jq  ". + { version: \"$version\" }" \

     

       72
       72
       -
             > $root/meta/snap.yaml

     

       73
       73
       -
         )

     

       74
       74
       -
       

     

       75
       75
       -
         (

     

       76
       76
       -
           # Copy the store closure in to the root

     

       77
       77
       -
           mkdir -p $root/nix/store

     

       78
       78
       -
           cat $closureInfo/store-paths | xargs -I{} cp -r {} $root/nix/store/

     

       79
       79
       -
         )

     

       80
       80
       -
       

     

       81
       81
       -
         # Generate the squashfs image.

     

       82
       82
       -
         mksquashfs $root $out \

     

       83
       83
       -
           ${lib.concatStringsSep " " mksquashfs_args}

     

       84
       84
       -
       ''

+1 -1

pkgs/top-level/all-packages.nix

···

       889
       889
        
       

     

       890
       890
        
         tarsum = callPackage ../build-support/docker/tarsum.nix { };

     

       891
       891
        
       

     

       892
       892
       -
         snapTools = callPackage ../build-support/snap { };

     

       892
       892
       +
         snapTools = throw "snapTools was removed because makeSnap produced broken snaps and it was the only function in snapTools. See https://github.com/NixOS/nixpkgs/issues/100618 for more details."; # 2024-03-04;

     

       893
       893
        
       

     

       894
       894
        
         nix-prefetch-docker = callPackage ../build-support/docker/nix-prefetch-docker.nix { };

     

       895
       895