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

Enable 'keyboard.json' as a build target #22891

Merged
merged 2 commits into from
Mar 10, 2024
Merged

Enable 'keyboard.json' as a build target #22891

merged 2 commits into from
Mar 10, 2024

Conversation

zvecr
Copy link
Member

@zvecr zvecr commented Jan 11, 2024

Description

Long term QMK wants to support a single data file for keyboard level config.

The current system requires a rules.mk even if the content is completely blank. The plan is to have info.json as potential fragments and add support for a new keyboard.json (supporting all info.json content) to mark a build target.

Achieving this goal will take multiple passes in order to not break everything in the short term and to keep the change sets reviewable. This first pass enables keyboard.json to exist so we can start the overall migration process.

Future:

  • Refactor keyboards to use keyboard.json
  • Remove use of DEFAULT_FOLDER
  • Remove rules.mk as build marker
  • Tidy up info.json code/docs references now 2 potential filenames exist

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

Copy link

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@github-actions github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Feb 28, 2024
@zvecr zvecr added awaiting review and removed stale Issues or pull requests that have become inactive without resolution. labels Feb 28, 2024
@tzarc tzarc added breaking_change_2024q2 develop-fast-track Intended to be merged early in the next develop cycle. labels Feb 28, 2024
@zvecr zvecr mentioned this pull request Apr 12, 2024
14 tasks
mechlovin pushed a commit to mechlovin/qmk_firmware that referenced this pull request Apr 15, 2024
0x647262 pushed a commit to 0x647262/qmk_firmware that referenced this pull request Apr 26, 2024
PepperLola pushed a commit to PepperLola/qmk_firmware that referenced this pull request May 29, 2024
Reyu added a commit to Reyu/qmk_firmware that referenced this pull request May 29, 2024
This change is in support of qmk/qmk_firmware#22891
which changes the build file marking a build target.
whoisjordangarcia pushed a commit to whoisjordangarcia/qmk_firmware that referenced this pull request Jun 8, 2024
nuphy-src pushed a commit to nuphy-src/qmk_firmware that referenced this pull request Jul 2, 2024
AJO-Python pushed a commit to AJO-Python/qmk_firmware that referenced this pull request Jul 7, 2024
jrtex pushed a commit to jrtex/qmk_firmware that referenced this pull request Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review cli qmk cli command core develop-fast-track Intended to be merged early in the next develop cycle. keyboard python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants