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.

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

Fix submodule check for qmk setup #11379

Merged

Conversation

graupe
Copy link

@graupe graupe commented Dec 31, 2020

The initialization of the submodules would succeed, but the result of the subsequent
check_submodules() run wasn't checked correctly.

Description

When bootstrapping a qmk_firmware repository, according to the documentation, there is an issue when calling qmk setup. That is, qmk is being installed via pip, not the one under bin/qmk. According to the docs.

Anyhow, the setup process asks to initialize the git submodules for the user, which it does on confirmation, but the check fails with a Not an iteratable-Error. I deem the problem fixed by this PR, but 1. I don't code python usually, 2. I only invested the minimum time.

I'm still confused why there is a bin/qmk but it doesn't have setup, yet the one installed via pip install still uses the local libraries in lib/python. Well. I hope this PR helps, but if not, it's fine with me.

Types of Changes

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

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).

The initialization of the submodules would succeed, but the result of the subsequent
check_submodules() run wasn't checked correctly.
@github-actions github-actions bot added cli qmk cli command python labels Dec 31, 2020
@zvecr zvecr requested review from Erovia, skullydazed and a team December 31, 2020 18:32
@graupe
Copy link
Author

graupe commented Feb 14, 2021

I'm aware, that this PR is not the greatest of all contributions, in terms of value and form. Still, I would appreciate some feed-back, if something in particular is missing?

@fauxpark fauxpark requested a review from a team February 14, 2021 21:28
@skullydazed
Copy link
Member

I'm aware, that this PR is not the greatest of all contributions, in terms of value and form. Still, I would appreciate some feed-back, if something in particular is missing?

We're a volunteer driven project. Usually delays like this are about our available time, not anything with the PR. We get around to them eventually.

@skullydazed skullydazed merged commit 4a10dfb into qmk:master Feb 16, 2021
@skullydazed
Copy link
Member

Thanks!

@graupe
Copy link
Author

graupe commented Feb 18, 2021

We're a volunteer driven project. Usually delays like this are about our available time, not anything with the PR. We get around to them eventually.

Thanks for your reply! I was mainly concerned, that I had missed some parts of the "how to make a pull request" statute.
Thanks for taking the time to review.

BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
The initialization of the submodules would succeed, but the result of the subsequent
check_submodules() run wasn't checked correctly.

Co-authored-by: Stefan Schulze <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli qmk cli command python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants