doc/hooks/versionCheckHook.section.md

   1 # versionCheckHook {#versioncheckhook}
   2
   3 This hook adds a `versionCheckPhase` to the [`preInstallCheckHooks`](#ssec-installCheck-phase) that runs the main program of the derivation with a `--help` or `--version` argument, and checks that the `${version}` string is found in that output. You use it like this:
   4
   5 ```nix
   6 {
   7   lib,
   8   stdenv,
   9   versionCheckHook,
  10   # ...
  11 }:
  12
  13 stdenv.mkDerivation (finalAttrs: {
  14   # ...
  15
  16   nativeInstallCheckInputs = [
  17     versionCheckHook
  18   ];
  19   doInstallCheck = true;
  20
  21   # ...
  22 })
  23 ```
  24
  25 Note that for [`buildPythonPackage`](#buildpythonpackage-function) and [`buildPythonApplication`](#buildpythonapplication-function), `doInstallCheck` is enabled by default.
  26
  27 It does so in a clean environment (using `env --ignore-environment`), and it checks for the `${version}` string in both the `stdout` and the `stderr` of the command. It will report to you in the build log the output it received and it will fail the build if it failed to find `${version}`.
  28
  29 The variables that this phase control are:
  30
  31 - `dontVersionCheck`: Disable adding this hook to the [`preInstallCheckHooks`](#ssec-installCheck-phase). Useful if you do want to load the bash functions of the hook, but run them differently.
  32 - `versionCheckProgram`: The full path to the program that should print the `${version}` string. Defaults roughly to `${placeholder "out"}/bin/${pname}`. Using `$out` in the value of this variable won't work, as environment variables from this variable are not expanded by the hook. Hence using `placeholder` is unavoidable.
  33 - `versionCheckProgramArg`: The argument that needs to be passed to `versionCheckProgram`. If undefined the hook tries first `--help` and then `--version`. Examples: `version`, `-V`, `-v`.
  34 - `preVersionCheck`: A hook to run before the check is done.
  35 - `postVersionCheck`: A hook to run after the check is done.