Can't update a Go package, getting `go: inconsistent vendoring`

doronbehar · April 8, 2023, 11:00pm

Thanks a lot for your help again. I finally figured this out :

This happens (probably only to me) due to installManPage in postBuild. The go-modules derivation inherits the postBuild that one would expect to be used by the main builder, not the builder of the go-modules derivation[1]:

github.com

NixOS/nixpkgs/blob/7f3f7ec38154b9f4eb551a67bfe4214db43d4200/pkgs/build-support/go/module.nix#L86-L92


      
          prePatch = args.prePatch or "";
          patches = args.patches or [];
          patchFlags = args.patchFlags or [];
          postPatch = args.postPatch or "";
          preBuild = args.preBuild or "";
          postBuild = args.postBuild or "";
          sourceRoot = args.sourceRoot or "";

Hence since go-modules runs my postBuild, the $out directory is already created due to installManPage (and the man page is installed there as well, without use of course). This makes the following command act differently:

github.com

NixOS/nixpkgs/blob/7f3f7ec38154b9f4eb551a67bfe4214db43d4200/pkgs/build-support/go/module.nix#L145


      
            runHook postBuild
          '';
          
          
installPhase = args.modInstallPhase or ''
            runHook preInstall
          
          
${if proxyVendor then ''
            rm -rf "''${GOPATH}/pkg/mod/cache/download/sumdb"
            cp -r --reflink=auto "''${GOPATH}/pkg/mod/cache/download" $out
          '' else ''
            cp -r --reflink=auto vendor $out
          ''}
          
          
  if ! [ "$(ls -A $out)" ]; then
              echo "vendor folder is empty, please set 'vendorHash = null;' or 'vendorSha256 = null;' in your expression"
              exit 10
            fi
          
          
  runHook postInstall
          '';

It copies the vendor directory into the $out directory, resulting in $out/vendor which becomes vendor/vendor in the main derivation.

[1]: This hooks inheritance behavior is something to be discussed and changed, IMO. Will open an issue or PR soon.