Commit d95d3724 authored by Adam Dinwoodie's avatar Adam Dinwoodie
Browse files

fetchgit: add preFetch hook 

This allows running code to change the environment before the
nix-prefetch-git script is run.  In particular, it allows setting things
like NIX_PREFETCH_GIT_CHECKOUT_HOOK, which allows additional code to be
run before deleting the .git directory.

This also means there's potentially value in performing a deep clone
then removing the .git directory, so remove the assertion that prevents
doing so.
parent ed30f8ab

doc/build-helpers/fetchers.chapter.md

+6 −1
Original line number Diff line number Diff line
@@ -773,9 +773,14 @@ Additionally, the following optional arguments can be given: 


: Whether to fetch LFS objects.



*`preFetch`* (String)



: Shell code to be executed before the repository has been fetched, to allow

  changing the environment the fetcher runs in.



*`postFetch`* (String)



: Shell code executed after the file has been fetched successfully.

: Shell code executed after the repository has been fetched successfully.

  This can do things like check or transform the file.



*`leaveDotGit`* (Boolean)

pkgs/build-support/fetchgit/builder.sh

+2 −0
Original line number Diff line number Diff line
@@ -6,6 +6,8 @@ 


echo "exporting $url (rev $rev) into $out"



runHook preFetch



$SHELL $fetcher --builder --url "$url" --out "$out" --rev "$rev" --name "$name" \

  ${leaveDotGit:+--leave-dotGit} \

  ${fetchLFS:+--fetch-lfs} \

pkgs/build-support/fetchgit/default.nix

+6 −1
Original line number Diff line number Diff line
@@ -38,6 +38,11 @@ lib.makeOverridable ( 
      nonConeMode ? false,

      name ? null,

      nativeBuildInputs ? [ ],

      # Shell code executed before the file has been fetched.  This, in

      # particular, can do things like set NIX_PREFETCH_GIT_CHECKOUT_HOOK to

      # run operations between the checkout completing and deleting the .git

      # directory.

      preFetch ? "",

      # Shell code executed after the file has been fetched

      # successfully. This can do things like check or transform the file.

      postFetch ? "",
@@ -75,7 +80,6 @@ lib.makeOverridable ( 
      server admins start using the new version?

    */



    assert deepClone -> leaveDotGit;

    assert nonConeMode -> (sparseCheckout != [ ]);



    let
@@ -130,6 +134,7 @@ lib.makeOverridable ( 
          deepClone

          branchName

          nonConeMode

          preFetch

          postFetch

          ;

        rev = revWithTag;