git-download: Add support for Git Large File Storage (LFS).
* guix/build/git.scm (git-fetch) [lfs?]: New argument, doc and setup code. (git-fetch-with-fallback) [lfs?]: New argument. Pass it to git-fetch. * guix/git-download.scm (git-lfs-package): New procedure. (git-fetch/in-band*): New procedure, made of the logic of git-fetch/in-band, with new git-lfs specifics, with the following changes: New #:git-lfs argument. <inputs>: Remove labels. Conditionally add git-lfs. <build>: Read "git lfs?" environment variable and pass its value to the #:lfs? argument of git-fetch-with-fallback. Use INPUTS directly; update comment. <gexp->derivation>: Add "git lfs?" to #:env-vars. (git-fetch/in-band): Express in terms of git-fetch/in-band*. (git-fetch/lfs): New procedure. * doc/guix.texi (origin Reference): Document it. Change-Id: I5b233b8642a7bdb8737b9d9b740e7254a89ccb25 Reviewed-by: Ludovic Courtès <ludo@gnu.org>master
parent
889a6204f8
commit
a4db19d8e0
|
@ -8375,6 +8375,13 @@ hash @var{hash} of type @var{hash-algo} (a symbol). Use @var{name} as
|
|||
the file name, or a generic name if @code{#f}.
|
||||
@end deffn
|
||||
|
||||
@deffn {Procedure} git-fetch/lfs ref hash-algo hash
|
||||
This is a variant of the @code{git-fetch} procedure that supports the
|
||||
Git @acronym{LFS, Large File Storage} extension. This may be useful to
|
||||
pull some binary test data to run the test suite of a package, for
|
||||
example.
|
||||
@end deffn
|
||||
|
||||
@deftp {Data Type} git-reference
|
||||
This data type represents a Git reference for @code{git-fetch} to
|
||||
retrieve.
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
;;; GNU Guix --- Functional package management for GNU
|
||||
;;; Copyright © 2014, 2016, 2019, 2023 Ludovic Courtès <ludo@gnu.org>
|
||||
;;; Copyright © 2023 Maxim Cournoyer <maxim.cournoyer@gmail.com>
|
||||
;;;
|
||||
;;; This file is part of GNU Guix.
|
||||
;;;
|
||||
|
@ -33,10 +34,13 @@
|
|||
;;; Code:
|
||||
|
||||
(define* (git-fetch url commit directory
|
||||
#:key (git-command "git") recursive?)
|
||||
#:key (git-command "git")
|
||||
lfs? recursive?)
|
||||
"Fetch COMMIT from URL into DIRECTORY. COMMIT must be a valid Git commit
|
||||
identifier. When RECURSIVE? is true, all the sub-modules of URL are fetched,
|
||||
recursively. Return #t on success, #f otherwise."
|
||||
identifier. When LFS? is true, configure Git to also fetch Large File
|
||||
Storage (LFS) files; it assumes that the @code{git-lfs} extension is available
|
||||
in the environment. When RECURSIVE? is true, all the sub-modules of URL are
|
||||
fetched, recursively. Return #t on success, #f otherwise."
|
||||
|
||||
;; Disable TLS certificate verification. The hash of the checkout is known
|
||||
;; in advance anyway.
|
||||
|
@ -57,6 +61,11 @@ recursively. Return #t on success, #f otherwise."
|
|||
(with-directory-excursion directory
|
||||
(invoke git-command "init" "--initial-branch=main")
|
||||
(invoke git-command "remote" "add" "origin" url)
|
||||
|
||||
(when lfs?
|
||||
(setenv "HOME" "/tmp")
|
||||
(invoke git-command "lfs" "install"))
|
||||
|
||||
(if (zero? (system* git-command "fetch" "--depth" "1" "origin" commit))
|
||||
(invoke git-command "checkout" "FETCH_HEAD")
|
||||
(begin
|
||||
|
@ -81,11 +90,13 @@ recursively. Return #t on success, #f otherwise."
|
|||
|
||||
|
||||
(define* (git-fetch-with-fallback url commit directory
|
||||
#:key (git-command "git") recursive?)
|
||||
#:key (git-command "git")
|
||||
lfs? recursive?)
|
||||
"Like 'git-fetch', fetch COMMIT from URL into DIRECTORY, but fall back to
|
||||
alternative methods when fetching from URL fails: attempt to download a nar,
|
||||
and if that also fails, download from the Software Heritage archive."
|
||||
(or (git-fetch url commit directory
|
||||
#:lfs? lfs?
|
||||
#:recursive? recursive?
|
||||
#:git-command git-command)
|
||||
(download-nar directory)
|
||||
|
|
|
@ -4,6 +4,7 @@
|
|||
;;; Copyright © 2017 Christopher Baines <mail@cbaines.net>
|
||||
;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
|
||||
;;; Copyright © 2023 Simon Tournier <zimon.toutoune@gmail.com>
|
||||
;;; Copyright © 2023 Maxim Cournoyer <maxim.cournoyer@gmail.com>
|
||||
;;;
|
||||
;;; This file is part of GNU Guix.
|
||||
;;;
|
||||
|
@ -54,6 +55,7 @@
|
|||
git-reference-recursive?
|
||||
|
||||
git-fetch
|
||||
git-fetch/lfs
|
||||
git-version
|
||||
git-file-name
|
||||
git-predicate))
|
||||
|
@ -79,30 +81,36 @@
|
|||
(let ((distro (resolve-interface '(gnu packages version-control))))
|
||||
(module-ref distro 'git-minimal)))
|
||||
|
||||
(define* (git-fetch/in-band ref hash-algo hash
|
||||
(define (git-lfs-package)
|
||||
"Return the default 'git-lfs' package."
|
||||
(let ((distro (resolve-interface '(gnu packages version-control))))
|
||||
(module-ref distro 'git-lfs)))
|
||||
|
||||
(define* (git-fetch/in-band* ref hash-algo hash
|
||||
#:optional name
|
||||
#:key (system (%current-system))
|
||||
(guile (default-guile))
|
||||
(git (git-package)))
|
||||
"Return a fixed-output derivation that performs a Git checkout of REF, using
|
||||
GIT and GUILE (thus, said derivation depends on GIT and GUILE).
|
||||
|
||||
This method is deprecated in favor of the \"builtin:git-download\" builder.
|
||||
It will be removed when versions of guix-daemon implementing
|
||||
\"builtin:git-download\" will be sufficiently widespread."
|
||||
(git (git-package))
|
||||
git-lfs)
|
||||
"Shared implementation code for git-fetch/in-band & friends. Refer to their
|
||||
respective documentation."
|
||||
(define inputs
|
||||
`(("git" ,(or git (git-package)))
|
||||
|
||||
;; When doing 'git clone --recursive', we need sed, grep, etc. to be
|
||||
;; available so that 'git submodule' works.
|
||||
`(,(or git (git-package))
|
||||
,@(if git-lfs
|
||||
(list git-lfs)
|
||||
'())
|
||||
,@(if (git-reference-recursive? ref)
|
||||
(standard-packages)
|
||||
;; TODO: remove (standard-packages) after
|
||||
;; 48e528a26f9c019eeaccf5e3de3126aa02c98d3b is merged into master;
|
||||
;; currently when doing 'git clone --recursive', we need sed, grep,
|
||||
;; etc. to be available so that 'git submodule' works.
|
||||
(map second (standard-packages))
|
||||
|
||||
;; The 'swh-download' procedure requires tar and gzip.
|
||||
`(("gzip" ,(module-ref (resolve-interface '(gnu packages compression))
|
||||
'gzip))
|
||||
("tar" ,(module-ref (resolve-interface '(gnu packages base))
|
||||
'tar))))))
|
||||
(list (module-ref (resolve-interface '(gnu packages compression))
|
||||
'gzip)
|
||||
(module-ref (resolve-interface '(gnu packages base))
|
||||
'tar)))))
|
||||
|
||||
(define guile-json
|
||||
(module-ref (resolve-interface '(gnu packages guile)) 'guile-json-4))
|
||||
|
@ -134,6 +142,9 @@ It will be removed when versions of guix-daemon implementing
|
|||
#:select (set-path-environment-variable))
|
||||
(ice-9 match))
|
||||
|
||||
(define lfs?
|
||||
(call-with-input-string (getenv "git lfs?") read))
|
||||
|
||||
(define recursive?
|
||||
(call-with-input-string (getenv "git recursive?") read))
|
||||
|
||||
|
@ -144,18 +155,17 @@ It will be removed when versions of guix-daemon implementing
|
|||
#+(file-append glibc-locales "/lib/locale"))
|
||||
(setlocale LC_ALL "en_US.utf8")
|
||||
|
||||
;; The 'git submodule' commands expects Coreutils, sed,
|
||||
;; grep, etc. to be in $PATH.
|
||||
(set-path-environment-variable "PATH" '("bin")
|
||||
(match '#+inputs
|
||||
(((names dirs outputs ...) ...)
|
||||
dirs)))
|
||||
;; The 'git submodule' commands expects Coreutils, sed, grep,
|
||||
;; etc. to be in $PATH. This also ensures that git extensions are
|
||||
;; found.
|
||||
(set-path-environment-variable "PATH" '("bin") '#+inputs)
|
||||
|
||||
(setvbuf (current-output-port) 'line)
|
||||
(setvbuf (current-error-port) 'line)
|
||||
|
||||
(git-fetch-with-fallback (getenv "git url") (getenv "git commit")
|
||||
#$output
|
||||
#:lfs? lfs?
|
||||
#:recursive? recursive?
|
||||
#:git-command "git")))))
|
||||
|
||||
|
@ -175,7 +185,8 @@ It will be removed when versions of guix-daemon implementing
|
|||
(git-reference-url ref))))
|
||||
("git commit" . ,(git-reference-commit ref))
|
||||
("git recursive?" . ,(object->string
|
||||
(git-reference-recursive? ref))))
|
||||
(git-reference-recursive? ref)))
|
||||
("git lfs?" . ,(if git-lfs "#t" "#f")))
|
||||
#:leaked-env-vars '("http_proxy" "https_proxy"
|
||||
"LC_ALL" "LC_MESSAGES" "LANG"
|
||||
"COLUMNS")
|
||||
|
@ -187,6 +198,36 @@ It will be removed when versions of guix-daemon implementing
|
|||
#:recursive? #t
|
||||
#:guile-for-build guile)))
|
||||
|
||||
(define* (git-fetch/in-band ref hash-algo hash
|
||||
#:optional name
|
||||
#:key (system (%current-system))
|
||||
(guile (default-guile))
|
||||
(git (git-package)))
|
||||
"Return a fixed-output derivation that performs a Git checkout of REF, using
|
||||
GIT and GUILE (thus, said derivation depends on GIT and GUILE).
|
||||
|
||||
This method is deprecated in favor of the \"builtin:git-download\" builder.
|
||||
It will be removed when versions of guix-daemon implementing
|
||||
\"builtin:git-download\" will be sufficiently widespread."
|
||||
(git-fetch/in-band* ref hash-algo hash name
|
||||
#:system system
|
||||
#:guile guile
|
||||
#:git git))
|
||||
|
||||
(define* (git-fetch/lfs ref hash-algo hash
|
||||
#:optional name
|
||||
#:key (system (%current-system))
|
||||
(guile (default-guile))
|
||||
(git (git-package))
|
||||
(git-lfs (git-lfs-package)))
|
||||
"Like git-fetch/in-band, but with support for the Git Large File
|
||||
Storage (LFS) extension."
|
||||
(git-fetch/in-band* ref hash-algo hash name
|
||||
#:system system
|
||||
#:guile guile
|
||||
#:git git
|
||||
#:git-lfs git-lfs))
|
||||
|
||||
(define* (git-fetch/built-in ref hash-algo hash
|
||||
#:optional name
|
||||
#:key (system (%current-system)))
|
||||
|
|
Reference in New Issue