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

CLI: Add git and venv info to doctor's output #13405

Merged
merged 1 commit into from
Jul 10, 2021
Merged

CLI: Add git and venv info to doctor's output #13405

merged 1 commit into from
Jul 10, 2021

Conversation

Erovia
Copy link
Member

@Erovia Erovia commented Jul 1, 2021

Description

Add git-related information such as branch, dirty-ness and deviation from master/develop to the output of qmk doctor.
Most of the checks are saved from zvecr's retired 'up/status' subcommand PR.

Although the end-goal for these checks to be used for the upcoming update subcommand, I think they are useful for assessing users' environment during debugging.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@github-actions github-actions bot added cli qmk cli command python labels Jul 1, 2021
@Erovia
CLI: Add git and venv info to doctor's output
c26a474 
Most of the checks are saved from zvecr's retired 'up/status'
subcommand PR.
@Erovia Erovia requested review from fauxpark, skullydazed and a team July 1, 2021 18:54
drashna
drashna approved these changes Jul 6, 2021
View reviewed changes
Copy link
Member

@drashna drashna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__attribute__((weak)) ✅

@Erovia Erovia merged commit e05f9c4 into qmk:develop Jul 10, 2021
@Erovia Erovia deleted the cli/git_stuff branch July 10, 2021 15:04
nhongooi pushed a commit to nhongooi/qmk_firmware that referenced this pull request Dec 5, 2021
@Erovia @nhongooi
CLI: Add git and venv info to doctor's output (qmk#13405)
fdbe349 
Most of the checks are saved from zvecr's retired 'up/status'
subcommand PR.
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
@Erovia
CLI: Add git and venv info to doctor's output (qmk#13405)
1f2441c 
Most of the checks are saved from zvecr's retired 'up/status'
subcommand PR.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fauxpark fauxpark fauxpark left review comments

@skullydazed skullydazed skullydazed approved these changes

@drashna drashna drashna approved these changes

Assignees
No one assigned
Labels
cli qmk cli command python
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Erovia @drashna @fauxpark @skullydazed