{ lib, repoRevToNameMaybe, fetchgit, fetchzip, }: let # Here defines fetchFromGitHub arguments that determines useFetchGit, # The attribute value is their default values. # As fetchFromGitHub prefers fetchzip for hash stability, # `defaultFetchGitArgs` attributes should lead to `useFetchGit = false`. useFetchGitArgsDefault = { deepClone = false; fetchSubmodules = false; # This differs from fetchgit's default fetchLFS = false; forceFetchGit = false; leaveDotGit = null; postCheckout = ""; rootDir = ""; sparseCheckout = null; }; useFetchGitArgsDefaultNullable = { leaveDotGit = false; sparseCheckout = [ ]; }; useFetchGitargsDefaultNonNull = useFetchGitArgsDefault // useFetchGitArgsDefaultNullable; # useFetchGitArgsWD to exclude from automatic passing. # Other useFetchGitArgsWD will pass down to fetchgit. excludeUseFetchGitArgNames = [ "forceFetchGit" ]; faUseFetchGit = lib.mapAttrs (_: _: true) useFetchGitArgsDefault; adjustFunctionArgs = f: lib.setFunctionArgs f (faUseFetchGit // lib.functionArgs f); decorate = f: lib.makeOverridable (adjustFunctionArgs f); in decorate ( { owner, repo, tag ? null, rev ? null, # TODO(@ShamrockLee): Add back after reconstruction with lib.extendMkDerivation # name ? repoRevToNameMaybe finalAttrs.repo (lib.revOrTag finalAttrs.revCustom finalAttrs.tag) "github", private ? false, githubBase ? "github.com", varPrefix ? null, passthru ? { }, meta ? { }, ... # For hash agility and additional fetchgit arguments }@args: assert ( lib.assertMsg (lib.xor (tag == null) ( rev == null )) "fetchFromGitHub requires one of either `rev` or `tag` to be provided (not both)." ); let useFetchGit = lib.mapAttrs ( name: nonNullDefault: if args ? ${name} && (useFetchGitArgsDefaultNullable ? ${name} -> args.${name} != null) then args.${name} else nonNullDefault ) useFetchGitargsDefaultNonNull != useFetchGitargsDefaultNonNull; useFetchGitArgsWDPassing = lib.overrideExisting (removeAttrs useFetchGitArgsDefault excludeUseFetchGitArgNames) args; 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" "private" "githubBase" "varPrefix" ] ++ (if useFetchGit then excludeUseFetchGitArgNames else lib.attrNames faUseFetchGit) ); varBase = "NIX${lib.optionalString (varPrefix != null) "_${varPrefix}"}_GITHUB_PRIVATE_"; # 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 <