feat: skip lfs smudge (#890)

* feat: skip lfs smudge

* docs: update README

* fix: pass env to git commands

extensions/sphinx-multiversion/README.md

@@ -44,7 +44,12 @@ smv_rename_latest_version = 'latest' # Use the commit hash
 
 ### Add support for custom tags
 
-See https://github.com/dgarcia360/sphinx-multiversion/pull/4.
+See https://github.com/dgarcia360/sphinx-multiversion/pull/4
+
+### Fix Git LFS error
+
+See https://github.com/scylladb/scylla-enterprise/issues/3414
+
 
 ## Maintenance
 

extensions/sphinx-multiversion/setup.py

@@ -21,7 +21,7 @@
     author="Jan Holthuis",
     author_email="[email protected]",
     url="https://holzhaus.github.io/sphinx-multiversion/",
-    version="0.2.18",
+    version="0.2.20",
     install_requires=["sphinx >= 2.1"],
     license="BSD",
     packages=["sphinx_multiversion"],

extensions/sphinx-multiversion/sphinx_multiversion/__init__.py

@@ -2,7 +2,7 @@
 from .main import main
 from .sphinx import setup
 
-__version__ = "0.2.13"
+__version__ = "0.2.20"
 
 __all__ = [
     "setup",

extensions/sphinx-multiversion/sphinx_multiversion/git.py

@@ -22,14 +22,16 @@
 
 logger = logging.getLogger(__name__)
 
+env = os.environ.copy()
+env['GIT_LFS_SKIP_SMUDGE'] = '1'
 
 def get_toplevel_path(cwd=None):
     cmd = (
         "git",
         "rev-parse",
         "--show-toplevel",
     )
-    output = subprocess.check_output(cmd, cwd=cwd).decode()
+    output = subprocess.check_output(cmd, cwd=cwd, env=env).decode()
     return output.rstrip("\n")
 
 
@@ -41,7 +43,7 @@ def get_all_refs(gitroot):
         "%(objectname)\t%(refname)\t%(creatordate:iso)",
         "refs",
     )
-    output = subprocess.check_output(cmd, cwd=gitroot).decode()
+    output = subprocess.check_output(cmd, cwd=gitroot, env=env).decode()
     for line in output.splitlines():
         is_remote = False
         fields = line.strip().split("\t")
@@ -135,7 +137,7 @@ def file_exists(gitroot, refname, filename):
         "{}:{}".format(refname, filename),
     )
     proc = subprocess.run(
-        cmd, cwd=gitroot, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
+        cmd, cwd=gitroot, env=env, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
     )
     return proc.returncode == 0
 
@@ -151,7 +153,7 @@ def copy_tree(gitroot, src, dst, reference, sourcepath="."):
             "--",
             sourcepath,
         )
-        subprocess.check_call(cmd, cwd=gitroot, stdout=fp)
+        subprocess.check_call(cmd, cwd=gitroot, env=env,stdout=fp)
         fp.seek(0)
         with tarfile.TarFile(fileobj=fp) as tarfp:
             tarfp.extractall(dst)