Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Report submodule status when not valid work-tree #19474

Merged
merged 1 commit into from
Jan 2, 2023
Merged

Report submodule status when not valid work-tree #19474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions lib/python/qmk/cli/doctor/check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,8 @@ def check_submodules():
"""
for submodule in submodules.status().values():
if submodule['status'] is None:
cli.log.error('Submodule %s has not yet been cloned!', submodule['name'])
return CheckStatus.ERROR
elif not submodule['status']:
cli.log.warning('Submodule %s is not up to date!', submodule['name'])
return CheckStatus.WARNING

return CheckStatus.OK
Expand Down
2 changes: 1 addition & 1 deletion lib/python/qmk/cli/doctor/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def doctor(cli):
if sub_ok == CheckStatus.OK:
cli.log.info('Submodules are up to date.')
else:
if yesno('Would you like to clone the submodules?', default=True):
if git_check_repo() and yesno('Would you like to clone the submodules?', default=True):
submodules.update()
sub_ok = check_submodules()

Expand Down
24 changes: 10 additions & 14 deletions lib/python/qmk/submodules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@ def status():
status is None when the submodule doesn't exist, False when it's out of date, and True when it's current
"""
submodules = {}
git_cmd = cli.run(['git', 'submodule', 'status'], timeout=30)

for line in git_cmd.stdout.split('\n'):
if not line:
continue
gitmodule_config = cli.run(['git', 'config', '-f', '.gitmodules', '-l'], timeout=30)
for line in gitmodule_config.stdout.splitlines():
key, value = line.split('=', maxsplit=2)
if key.endswith('.path'):
submodules[value] = {'name': value, 'status': None}

git_cmd = cli.run(['git', 'submodule', 'status'], timeout=30)
for line in git_cmd.stdout.splitlines():
status = line[0]
githash, submodule = line[1:].split()[:2]
submodules[submodule] = {'name': submodule, 'githash': githash}
submodules[submodule]['githash'] = githash

if status == '-':
submodules[submodule]['status'] = None
Expand All @@ -41,21 +43,15 @@ def status():
raise ValueError('Unknown `git submodule status` sha-1 prefix character: "%s"' % status)

submodule_logs = cli.run(['git', 'submodule', '-q', 'foreach', 'git --no-pager log --no-show-signature --pretty=format:"$sm_path%x01%h%x01%ad%x01%s%x0A" --date=iso -n1'])
for log_line in submodule_logs.stdout.split('\n'):
if not log_line:
continue

for log_line in submodule_logs.stdout.splitlines():
r = log_line.split('\x01')
submodule = r[0]
submodules[submodule]['shorthash'] = r[1] if len(r) > 1 else ''
submodules[submodule]['last_log_timestamp'] = r[2] if len(r) > 2 else ''
submodules[submodule]['last_log_message'] = r[3] if len(r) > 3 else ''

submodule_tags = cli.run(['git', 'submodule', '-q', 'foreach', '\'echo $sm_path `git describe --tags`\''])
for log_line in submodule_tags.stdout.split('\n'):
if not log_line:
continue

for log_line in submodule_tags.stdout.splitlines():
r = log_line.split()
submodule = r[0]
submodules[submodule]['describe'] = r[1] if len(r) > 1 else ''
Expand Down