Provide sensible error message when git not found (#1797)

mkdocs · Nov 27, 2019 · 98823e0 · 98823e0
1 parent f44428c
commit 98823e0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md
@@ -65,6 +65,7 @@ your global navigation uses more than one level, things will likely be broken.
 * Bugfix: Skip external URLs in sitemap.xml (#1742).
 * Bugfix: Ensure theme files do not override docs_dir files on Windows (#1876)
 * Add canonical tag to `readthedocs` theme (#1669).
+* Improved error message for when `git` is not available.
 
 ## Version 1.0.4 (2018-09-07)
 

diff --git a/mkdocs/commands/gh_deploy.py b/mkdocs/commands/gh_deploy.py
@@ -14,8 +14,15 @@
 
 
 def _is_cwd_git_repo():
-    proc = subprocess.Popen(['git', 'rev-parse', '--is-inside-work-tree'],
-                            stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    try:
+        proc = subprocess.Popen(
+            ['git', 'rev-parse', '--is-inside-work-tree'],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE
+        )
+    except FileNotFoundError:
+        log.error("Could not find git - is it installed and on your path?")
+        raise SystemExit(1)
     proc.communicate()
     return proc.wait() == 0