{ lib, repoRevToNameMaybe, fetchgit, fetchzip, }: lib.makeOverridable ( { owner, repo, tag ? null, rev ? null, name ? repoRevToNameMaybe repo (lib.revOrTag rev tag) "github", fetchSubmodules ? false, leaveDotGit ? null, deepClone ? false, private ? false, forceFetchGit ? false, fetchLFS ? false, sparseCheckout ? [ ], githubBase ? "github.com", varPrefix ? null, meta ? { }, ... # For hash agility }@args: assert ( lib.assertMsg (lib.xor (tag == null) ( rev == null )) "fetchFromGitHub requires one of either `rev` or `tag` to be provided (not both)." ); let position = ( if args.meta.description or null != null then builtins.unsafeGetAttrPos "description" args.meta else if tag != null then builtins.unsafeGetAttrPos "tag" args else builtins.unsafeGetAttrPos "rev" args ); baseUrl = "https://${githubBase}/${owner}/${repo}"; newMeta = meta // { homepage = meta.homepage or baseUrl; } // lib.optionalAttrs (position != null) { # to indicate where derivation originates, similar to make-derivation.nix's mkDerivation position = "${position.file}:${toString position.line}"; }; passthruAttrs = removeAttrs args [ "owner" "repo" "tag" "rev" "fetchSubmodules" "forceFetchGit" "private" "githubBase" "varPrefix" ]; varBase = "NIX${lib.optionalString (varPrefix != null) "_${varPrefix}"}_GITHUB_PRIVATE_"; useFetchGit = fetchSubmodules || (leaveDotGit == true) || deepClone || forceFetchGit || fetchLFS || (sparseCheckout != [ ]); # We prefer fetchzip in cases we don't need submodules as the hash # is more stable in that case. fetcher = if useFetchGit then fetchgit # fetchzip may not be overridable when using external tools, for example nix-prefetch else if fetchzip ? override then fetchzip.override { withUnzip = false; } else fetchzip; privateAttrs = lib.optionalAttrs private { netrcPhase = # When using private repos: # - Fetching with git works using https://github.com but not with the GitHub API endpoint # - Fetching a tarball from a private repo requires to use the GitHub API endpoint let machineName = if githubBase == "github.com" && !useFetchGit then "api.github.com" else githubBase; in '' if [ -z "''$${varBase}USERNAME" -o -z "''$${varBase}PASSWORD" ]; then echo "Error: Private fetchFromGitHub requires the nix building process (nix-daemon in multi user mode) to have the ${varBase}USERNAME and ${varBase}PASSWORD env vars set." >&2 exit 1 fi cat > netrc <