Skip to content

Produce warning if keyboard is not configured via keyboard.json #23321

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

Merged
merged 3 commits into from
Apr 1, 2024

Conversation

zvecr
Copy link
Member

@zvecr zvecr commented Mar 21, 2024

Description

With the many keyboard level migrations to use keyboard.json, there is currently nothing user facing to show that a keyboard is still using the legacy method of rules.mk.

This PR adds a lint/build warning when a keyboard has fallen back to backwards compatibility. Which after backwards compatibility is removed, can easily be promoted to a build error.

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 python cli qmk cli command labels Mar 21, 2024
@zvecr zvecr changed the title Produce warning if 'keyboard.json' has not been used Produce warning if keyboard.json has not been used Mar 21, 2024
@zvecr zvecr force-pushed the warn_keyboard_json_missing branch from d3a56e6 to 8dc1f6f Compare March 21, 2024 03:35
@zvecr zvecr changed the title Produce warning if keyboard.json has not been used Produce warning if keyboard is not configured via keyboard.json Mar 21, 2024
@zvecr zvecr requested a review from a team March 21, 2024 06:50
@zvecr zvecr force-pushed the warn_keyboard_json_missing branch from 8dc1f6f to 0fa8698 Compare April 1, 2024 13:46
@github-actions github-actions bot removed the keyboard label Apr 1, 2024
@zvecr zvecr merged commit 573db7a into develop Apr 1, 2024
@zvecr zvecr deleted the warn_keyboard_json_missing branch April 1, 2024 23:48
whoisjordangarcia pushed a commit to whoisjordangarcia/qmk_firmware that referenced this pull request Jun 8, 2024
nuess0r pushed a commit to nuess0r/qmk_firmware that referenced this pull request Sep 8, 2024
Ardakilic pushed a commit to Ardakilic/qmk_firmware that referenced this pull request Sep 10, 2024
MasayukiFukada pushed a commit to MasayukiFukada/qmk_firmware that referenced this pull request May 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants