commit 79e1351046bfeb879bd8064d34904b4c6a281f04 · pyrox.dev/nixpkgs

+89 -21

doc/stdenv/stdenv.chapter.md

···

       380
       380
        
       

     

       381
       381
        
       #### `passthru.updateScript` {#var-passthru-updateScript}

     

       382
       382
        
       

     

       383
       383
       -
       A script to be run by `maintainers/scripts/update.nix` when the package is matched. It needs to be an executable file, either on the file system:

     

       383
       383
       +
       A script to be run by `maintainers/scripts/update.nix` when the package is matched. The attribute can contain one of the following:

     

       384
       384
        
       

     

       385
       385
       -
       ```nix

     

       386
       386
       -
       passthru.updateScript = ./update.sh;

     

       387
       387
       -
       ```

     

       385
       385
       +
       - []{#var-passthru-updateScript-command} an executable file, either on the file system:

     

       388
       386
        
       

     

       389
       389
       -
       or inside the expression itself:

     

       387
       387
       +
         ```nix

     

       388
       388
       +
         passthru.updateScript = ./update.sh;

     

       389
       389
       +
         ```

     

       390
       390
        
       

     

       391
       391
       -
       ```nix

     

       392
       392
       -
       passthru.updateScript = writeScript "update-zoom-us" ''

     

       393
       393
       -
         #!/usr/bin/env nix-shell

     

       394
       394
       -
         #!nix-shell -i bash -p curl pcre common-updater-scripts

     

       391
       391
       +
         or inside the expression itself:

     

       392
       392
       +
       

     

       393
       393
       +
         ```nix

     

       394
       394
       +
         passthru.updateScript = writeScript "update-zoom-us" ''

     

       395
       395
       +
           #!/usr/bin/env nix-shell

     

       396
       396
       +
           #!nix-shell -i bash -p curl pcre common-updater-scripts

     

       397
       397
       +
       

     

       398
       398
       +
           set -eu -o pipefail

     

       399
       399
       +
       

     

       400
       400
       +
           version="$(curl -sI https://zoom.us/client/latest/zoom_x86_64.tar.xz | grep -Fi 'Location:' | pcregrep -o1 '/(([0-9]\.?)+)/')"

     

       401
       401
       +
           update-source-version zoom-us "$version"

     

       402
       402
       +
         '';

     

       403
       403
       +
         ```

     

       404
       404
       +
       

     

       405
       405
       +
       - a list, a script followed by arguments to be passed to it:

     

       395
       406
        
       

     

       396
       396
       -
         set -eu -o pipefail

     

       407
       407
       +
         ```nix

     

       408
       408
       +
         passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ];

     

       409
       409
       +
         ```

     

       397
       410
        
       

     

       398
       398
       -
         version="$(curl -sI https://zoom.us/client/latest/zoom_x86_64.tar.xz | grep -Fi 'Location:' | pcregrep -o1 '/(([0-9]\.?)+)/')"

     

       399
       399
       -
         update-source-version zoom-us "$version"

     

       400
       400
       -
       '';

     

       401
       401
       -
       ```

     

       411
       411
       +
       - an attribute set containing:

     

       412
       412
       +
         - [`command`]{#var-passthru-updateScript-set-command} – a string or list in the [format expected by `passthru.updateScript`](#var-passthru-updateScript-command).

     

       413
       413
       +
         - [`attrPath`]{#var-passthru-updateScript-set-attrPath} (optional) – a string containing the canonical attribute path for the package. If present, it will be passed to the update script instead of the attribute path on which the package was discovered during Nixpkgs traversal.

     

       414
       414
       +
         - [`supportedFeatures`]{#var-passthru-updateScript-set-supportedFeatures} (optional) – a list of the [extra features](#var-passthru-updateScript-supported-features) the script supports.

     

       402
       415
        
       

     

       403
       403
       -
       The attribute can also contain a list, a script followed by arguments to be passed to it:

     

       416
       416
       +
         ```nix

     

       417
       417
       +
         passthru.updateScript = {

     

       418
       418
       +
           command = [ ../../update.sh pname ];

     

       419
       419
       +
           attrPath = pname;

     

       420
       420
       +
           supportedFeatures = [ … ];

     

       421
       421
       +
         };

     

       422
       422
       +
         ```

     

       404
       423
        
       

     

       405
       405
       -
       ```nix

     

       406
       406
       -
       passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ];

     

       407
       407
       -
       ```

     

       424
       424
       +
       ##### How update scripts are executed? {#var-passthru-updateScript-execution}

     

       408
       425
        
       

     

       409
       409
       -
       The script will be run with the `UPDATE_NIX_NAME`, `UPDATE_NIX_PNAME`, `UPDATE_NIX_OLD_VERSION` and `UPDATE_NIX_ATTR_PATH` environment variables set respectively to the name, pname, old version and attribute path of the package it is supposed to update.

     

       426
       426
       +
       Update scripts are to be invoked by `maintainers/scripts/update.nix` script. You can run `nix-shell maintainers/scripts/update.nix` in the root of Nixpkgs repository for information on how to use it. `update.nix` offers several modes for selecting packages to update (e.g. select by attribute path, traverse Nixpkgs and filter by maintainer, etc.), and it will execute update scripts for all matched packages that have an `updateScript` attribute.

     

       427
       427
       +
       

     

       428
       428
       +
       Each update script will be passed the following environment variables:

     

       429
       429
       +
       

     

       430
       430
       +
       - [`UPDATE_NIX_NAME`]{#var-passthru-updateScript-env-UPDATE_NIX_NAME} – content of the `name` attribute of the updated package.

     

       431
       431
       +
       - [`UPDATE_NIX_PNAME`]{#var-passthru-updateScript-env-UPDATE_NIX_PNAME} – content of the `pname` attribute of the updated package.

     

       432
       432
       +
       - [`UPDATE_NIX_OLD_VERSION`]{#var-passthru-updateScript-env-UPDATE_NIX_OLD_VERSION} – content of the `version` attribute of the updated package.

     

       433
       433
       +
       - [`UPDATE_NIX_ATTR_PATH`]{#var-passthru-updateScript-env-UPDATE_NIX_ATTR_PATH} – attribute path the `update.nix` discovered the package on (or the [canonical `attrPath`](#var-passthru-updateScript-set-attrPath) when available). Example: `pantheon.elementary-terminal`

     

       410
       434
        
       

     

       411
       435
        
       ::: {.note}

     

       412
       412
       -
       The script will be usually run from the root of the Nixpkgs repository but you should not rely on that. Also note that the update scripts will be run in parallel by default; you should avoid running `git commit` or any other commands that cannot handle that.

     

       436
       436
       +
       An update script will be usually run from the root of the Nixpkgs repository but you should not rely on that. Also note that `update.nix` executes update scripts in parallel by default so you should avoid running `git commit` or any other commands that cannot handle that.

     

       437
       437
       +
       :::

     

       438
       438
       +
       

     

       439
       439
       +
       ::: {.tip}

     

       440
       440
       +
       While update scripts should not create commits themselves, `maintainers/scripts/update.nix` supports automatically creating commits when running it with `--argstr commit true`. If you need to customize commit message, you can have the update script implement [`commit`](#var-passthru-updateScript-commit) feature.

     

       413
       441
        
       :::

     

       414
       442
        
       

     

       415
       415
       -
       For information about how to run the updates, execute `nix-shell maintainers/scripts/update.nix`.

     

       443
       443
       +
       ##### Supported features {#var-passthru-updateScript-supported-features}

     

       444
       444
       +
       ###### `commit` {#var-passthru-updateScript-commit}

     

       445
       445
       +
       

     

       446
       446
       +
       This feature allows update scripts to *ask* `update.nix` to create Git commits.

     

       447
       447
       +
       

     

       448
       448
       +
       When support of this feature is declared, whenever the update script exits with `0` return status, it is expected to print a JSON list containing an object described below for each updated attribute to standard output.

     

       449
       449
       +
       

     

       450
       450
       +
       When `update.nix` is run with `--argstr commit true` arguments, it will create a separate commit for each of the objects. An empty list can be returned when the script did not update any files, for example, when the package is already at the latest version.

     

       451
       451
       +
       

     

       452
       452
       +
       The commit object contains the following values:

     

       453
       453
       +
       

     

       454
       454
       +
       - [`attrPath`]{#var-passthru-updateScript-commit-attrPath} – a string containing attribute path.

     

       455
       455
       +
       - [`oldVersion`]{#var-passthru-updateScript-commit-oldVersion} – a string containing old version.

     

       456
       456
       +
       - [`newVersion`]{#var-passthru-updateScript-commit-newVersion} – a string containing new version.

     

       457
       457
       +
       - [`files`]{#var-passthru-updateScript-commit-files} – a non-empty list of file paths (as strings) to add to the commit.

     

       458
       458
       +
       - [`commitBody`]{#var-passthru-updateScript-commit-commitBody} (optional) – a string with extra content to be appended to the default commit message (useful for adding changelog links).

     

       459
       459
       +
       - [`commitMessage`]{#var-passthru-updateScript-commit-commitMessage} (optional) – a string to use instead of the default commit message.

     

       460
       460
       +
       

     

       461
       461
       +
       If the returned array contains exactly one object (e.g. `[{}]`), all values are optional and will be determined automatically.

     

       462
       462
       +
       

     

       463
       463
       +
       ```{=docbook}

     

       464
       464
       +
       <example>

     

       465
       465
       +
       <title>Standard output of an update script using commit feature</title>

     

       466
       466
       +
       ```

     

       467
       467
       +
       

     

       468
       468
       +
       ```json

     

       469
       469
       +
       [

     

       470
       470
       +
         {

     

       471
       471
       +
           "attrPath": "volume_key",

     

       472
       472
       +
           "oldVersion": "0.3.11",

     

       473
       473
       +
           "newVersion": "0.3.12",

     

       474
       474
       +
           "files": [

     

       475
       475
       +
             "/path/to/nixpkgs/pkgs/development/libraries/volume-key/default.nix"

     

       476
       476
       +
           ]

     

       477
       477
       +
         }

     

       478
       478
       +
       ]

     

       479
       479
       +
       ```

     

       480
       480
       +
       

     

       481
       481
       +
       ```{=docbook}

     

       482
       482
       +
       </example>

     

       483
       483
       +
       ```

     

       416
       484
        
       

     

       417
       485
        
       ### Recursive attributes in `mkDerivation` {#mkderivation-recursive-attributes}

     

       418
       486

+2 -2

pkgs/applications/graphics/ImageMagick/default.nix

···

       47
       47
        
       

     

       48
       48
        
       stdenv.mkDerivation (finalAttrs: {

     

       49
       49
        
         pname = "imagemagick";

     

       50
       50
       -
         version = "7.1.1-3";

     

       50
       50
       +
         version = "7.1.1-4";

     

       51
       51
        
       

     

       52
       52
        
         src = fetchFromGitHub {

     

       53
       53
        
           owner = "ImageMagick";

     

       54
       54
        
           repo = "ImageMagick";

     

       55
       55
        
           rev = finalAttrs.version;

     

       56
       56
       -
           hash = "sha256-UYmWNP+2FdBtBUqQtYGtIdw/XN8OKO0r5g4zgzPgbP8=";

     

       56
       56
       +
           hash = "sha256-NGtctktlaKIZ3KZUysXBUTHtvAe29RYW3Q4SL6/Eufw=";

     

       57
       57
        
         };

     

       58
       58
        
       

     

       59
       59
        
         outputs = [ "out" "dev" "doc" ]; # bin/ isn't really big

+3 -3

pkgs/development/tools/language-servers/millet/default.nix

···

       2
       2
        
       

     

       3
       3
        
       rustPlatform.buildRustPackage rec {

     

       4
       4
        
         pname = "millet";

     

       5
       5
       -
         version = "0.8.1";

     

       5
       5
       +
         version = "0.8.3";

     

       6
       6
        
       

     

       7
       7
        
         src = fetchFromGitHub {

     

       8
       8
        
           owner = "azdavis";

     

       9
       9
        
           repo = pname;

     

       10
       10
        
           rev = "v${version}";

     

       11
       11
       -
           hash = "sha256-yIOb6AeEpIbKarY4I0X4zq5Gtrv05QLrDlFaBD3x6rw=";

     

       11
       11
       +
           hash = "sha256-b5zb0sDya/58kEEgqWqu4u6Xo61sq8Le0F3Z1Q3dBdk=";

     

       12
       12
        
         };

     

       13
       13
        
       

     

       14
       14
       -
         cargoHash = "sha256-DIRs+xhcdV74NFjsB1jJYgd8Cu/BmAUcBf58rGAp/yo=";

     

       14
       14
       +
         cargoHash = "sha256-5uURD+c5OR2ACS2a3OYlPX/EpJ966+m97MDKyw3snjA=";

     

       15
       15
        
       

     

       16
       16
        
         postPatch = ''

     

       17
       17
        
           rm .cargo/config.toml