alvierahman90/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doctor: add check for .git folder (#11208)

Browse Source 
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
This commit is contained in:
Ryan 2020-12-21 01:46:01 +11:00 committed by GitHub
parent 13bbeefc5a
commit 0239ce025a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
lib/python/qmk/cli/doctor.py
View File

@ -154,6 +154,17 @@ def check_submodules():
return CheckStatus.OK return CheckStatus.OK
def check_git_repo():
"""Checks that the .git directory exists inside QMK_HOME.
This is a decent enough indicator that the qmk_firmware directory is a
proper Git repository, rather than a .zip download from GitHub.
"""
dot_git_dir = QMK_FIRMWARE / '.git'
return CheckStatus.OK if dot_git_dir.is_dir() else CheckStatus.WARNING
def check_udev_rules(): def check_udev_rules():
"""Make sure the udev rules look good. """Make sure the udev rules look good.
""" """
@ -338,6 +349,13 @@ def doctor(cli):
cli.log.info('QMK home: {fg_cyan}%s', QMK_FIRMWARE) cli.log.info('QMK home: {fg_cyan}%s', QMK_FIRMWARE)
# Make sure our QMK home is a Git repo
git_ok = check_git_repo()
if git_ok == CheckStatus.WARNING:
cli.log.warning("QMK home does not appear to be a Git repository! (no .git folder)")
status = CheckStatus.WARNING
# Make sure the basic CLI tools we need are available and can be executed. # Make sure the basic CLI tools we need are available and can be executed.
bin_ok = check_binaries() bin_ok = check_binaries()