Compare commits

..
Author SHA1 Message Date
dependabot[bot]
ed3721648a
Bump actions/upload-artifact from 6 to 7
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-02-26 19:43:46 +00:00
Joel Challis
9e8199c411
Print keymap name within new-keymap error message (#26034) 2026-02-24 19:23:04 +00:00
Joel Challis
7bea08cb12
Enable strict linting for keyboard PRs (#26026) 2026-02-20 12:56:19 +00:00
Joel Challis
e52319b751
Check PRs for invalid keyboard build targets (#25992) 2026-02-18 00:06:23 +00:00
Jakob Schikowski
1ba0300da7
Fix JSON type for SELECT_SOFT_SERIAL_SPEED (#26003) 2026-02-17 10:00:51 -07:00
Joshua Diamond
3ac6f603a8
Mark encoders as such in dmqdesign/spin (#25973) 2026-02-13 18:22:06 +00:00
Joel Challis
63a3fc3591
Fix qmk flash handling of paths relative to qmk_firmware (#25993) 2026-02-13 18:21:51 +00:00
ivan
45ccd2e935
Add ows steno board (#25984) 2026-02-11 12:23:30 -08:00
Mikko Turunen
b01ed7d34f
Adding a new keyboard - Slothie60 (#24931)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2026-02-10 00:36:35 -08:00
Sebastiaan Swinkels
a7f524f264
Added MK Point65 keyboards and keymaps (#25392) 2026-02-10 00:20:34 -08:00
Thanh Son Tran
8a6c081c4a
[Keyboard] Add support Tyson88 (#25699)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Trần Thanh Sơn <son.tt1@teko.vn>
2026-02-09 23:51:34 -08:00
Joel Challis
b6d46cdc47
Allow json keymaps to include a user provided keymap.h (#25987) 2026-02-09 08:59:34 +08:00
Nate Eagleson
6729379041
Fix typo in ergodox-ez's readme (#25985)
Fix typo in readme.md
2026-02-06 15:14:23 +08:00
Drashna Jaelre
38815db760
Fixup tominabox1 le chiffre default keymap (#25966)
* Fixup tominabox1 le chiffre default keymap

* Apply suggestions from code review

Co-authored-by: Jack Sangdahl <jack@pngu.org>

---------

Co-authored-by: Jack Sangdahl <jack@pngu.org>
2026-01-25 08:43:55 +08:00
Joel Challis
863b308519
Fix avrdude version check logic (#25957) 2026-01-20 08:48:51 +00:00
Nick Brassel
127c664647
Backport GitHub Copilot instructions. (#25953) 2026-01-15 11:47:35 +11:00
Joel Challis
7d66c11f37
Lint default dynamic keymap layer count (#25948) 2026-01-13 16:48:59 +11:00
Joel Challis
e391793f73
Remove binary symbols from keymaps (#25947) 2026-01-11 18:15:14 +00:00
Álvaro A. Volpato
70c36c6c97
First support for KKC Wily (#25852) 2026-01-11 09:47:23 -08:00
Thanh Son Tran
56a2e332e1
Update tyson60 pid (#25935)
* Update support S6xty5

* Delete chconf.h

* Update manufacturer, community layout for hhkb

* Update layout

* fix row index

* Update tyson60s

* Update community layout and layout name

* Update remove rgb test mode

* Update capslock led

* Apply suggestions from code review

Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>

* Remove deprecated s6xty5

* Update tyson60 product id

---------

Co-authored-by: Trần Thanh Sơn <son.tt1@teko.vn>
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
2026-01-10 08:01:15 +08:00
dependabot[bot]
e31384babf
Bump JamesIves/github-pages-deploy-action from 4.7.6 to 4.8.0 (#25943)
Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.6 to 4.8.0.
- [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases)
- [Commits](https://github.com/jamesives/github-pages-deploy-action/compare/v4.7.6...v4.8.0)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  dependency-version: 4.8.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-01-09 19:50:23 +00:00
Joel Challis
a0b15d08bc
Short term fix for avr-libc@2.3.0 (#25938) 2026-01-08 16:36:40 +11:00
Stefan Gluszek
3d591a2000
Update fatotesa keyboard config. (#25811) 2026-01-07 21:08:05 +00:00
Joel Challis
1e683923e1
Handle broken symlinks in qmk doctor udev checks (#25934)
Handle broken symlinks in 'qmk doctor' udev checks
2026-01-07 18:24:16 +08:00
Pascal Getreuer
3194862502
docs/tap_hold.md fixes: Note that Chordal Hold supports multiple same-side mods and fix heading for Speculative Hold. (#25924)
* Note Chordal Hold supports multiple same-side mods.

* Fix "Speculative Hold" heading from H3 -> H2.
2026-01-04 07:00:50 +08:00
Ed Flanagan
8c035c2116
Fix small typo in WS2812 driver doc (#25928)
`ws812` -> `ws2812`
2026-01-03 20:18:41 +00:00
nullptr
91a9f9e492
Fix RGB Matrix Typing Heatmap overflow (#25915) 2026-01-03 19:45:29 +00:00
Jack Sangdahl
ddeaa26fef
Add .env, .envrc to gitignore (#25904) 2026-01-03 13:55:17 +00:00
Aymeric Wibo
f3a16ef21d
Fix typos in Aleblazer Zodiark readme (#25925) 2026-01-03 13:53:13 +00:00
QMK Bot
99b5b9ab7f
[CI] Regenerate Files (#25920)
Regenerate Files
2026-01-01 12:19:14 +00:00
Piervit
6a5610a8be
Fix functions layer_debug and default_layer_debug (#25913)
Co-authored-by: Joel Challis <git@zvecr.com>
2026-01-01 00:37:25 -08:00
Joel Challis
acbeec29da
Reduce frequency of automatic workflow run approval (#25896) 2025-12-25 00:24:50 +00:00
Danny
7e35cdda8a
Add FoldKB Rev. 2.1 with added underglow RGB LEDs (#25885) 2025-12-23 00:00:57 +00:00
Joel Challis
dba60e2e65
Re-fix building of XAP keymaps on master/develop (#25892) 2025-12-21 15:07:40 +11:00
Joel Challis
c68281b353
Handle building of XAP keymaps on master/develop (#25848) 2025-12-21 07:33:58 +11:00
Joel Challis
84d44e6188
Update bootstrap_testing.yml 2025-12-19 02:26:58 +00:00
Joel Challis
54e8fad959
Ignore merge commits on bootstrap testing PRs (#25884) 2025-12-19 02:23:29 +00:00
Joel Challis
2c847b0350
Consistently install branch specific dependencies in CI (#25874) 2025-12-15 00:21:06 +00:00
dependabot[bot]
e1c869b8da
Bump actions/download-artifact from 6 to 7 (#25873)
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-12 21:16:52 +00:00
dependabot[bot]
9e0118172f
Bump actions/upload-artifact from 5 to 6 (#25872)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 5 to 6.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-12 20:11:19 +00:00
Joel Challis
4f9582da26
Install branch specific dependencies as part of bootstrap testing (#25871) 2025-12-12 18:30:46 +00:00
Joshua Diamond
2e68ddc826
Fix broken compilation when OS_DETECTION_DEBUG_ENABLE is defined (#25869)
Fix include in os_detection (broken in https://github.com/qmk/qmk_firmware/pull/24356)
2025-12-12 18:17:42 +00:00
dependabot[bot]
c1fedab457
Bump peter-evans/create-pull-request from 7 to 8 (#25868)
Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 7 to 8.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](https://github.com/peter-evans/create-pull-request/compare/v7...v8)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-10 19:12:17 +00:00
dependabot[bot]
2929448605
Bump JamesIves/github-pages-deploy-action from 4.7.5 to 4.7.6 (#25867)
Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.5 to 4.7.6.
- [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases)
- [Commits](https://github.com/jamesives/github-pages-deploy-action/compare/v4.7.5...v4.7.6)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  dependency-version: 4.7.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-10 19:11:25 +00:00
dependabot[bot]
b39661de96
Bump JamesIves/github-pages-deploy-action from 4.7.4 to 4.7.5 (#25865)
Bumps [JamesIves/github-pages-deploy-action](https://github.com/jamesives/github-pages-deploy-action) from 4.7.4 to 4.7.5.
- [Release notes](https://github.com/jamesives/github-pages-deploy-action/releases)
- [Commits](https://github.com/jamesives/github-pages-deploy-action/compare/v4.7.4...v4.7.5)

---
updated-dependencies:
- dependency-name: JamesIves/github-pages-deploy-action
  dependency-version: 4.7.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-09 19:16:07 +00:00
dependabot[bot]
ff75bce86a
Bump actions/github-script from 6 to 8 (#25866)
Bumps [actions/github-script](https://github.com/actions/github-script) from 6 to 8.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/v6...v8)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-09 19:15:23 +00:00
Sắn
0881e0867b
Add support for Kami65 PCB (#24604)
Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-12-08 20:06:24 -08:00
Philip
e6e66a9f2e
Update dactyl_manuform 5x8 keyboard.json (#24778) 2025-12-08 19:33:02 -08:00
lental
e2d19eda57
Add queue.len() keyboard (#24823)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-12-08 19:30:39 -08:00
Joel Challis
73a6496516
Trigger develop docs rebuild on push (#25863) 2025-12-09 00:21:25 +00:00
Joel Challis
c8f6e6a936
Revert "Trigger develop docs rebuild on push" (#25862)
Revert "Trigger develop docs rebuild on push (#25860)"

This reverts commit a86322e4a7.
2025-12-08 22:55:58 +00:00
Joel Challis
a86322e4a7
Trigger develop docs rebuild on push (#25860) 2025-12-08 22:26:14 +00:00
ploopyco
505e5c7033
Add new mouse "Ploopy Nano 2 Trackball" (#25762) 2025-12-08 14:24:42 -08:00
Jon Colverson
107812ceef
[Keyboard] Add PicoFX (#25704) 2025-12-08 20:31:24 +00:00
Fabian Felix Selbach
de8f05b4c3
[Keyboard] Add support for Alpha FS (#25756) 2025-12-08 20:21:12 +00:00
psych3r
08e5fcfdf4
Fix USER_PATH resolution on case-insensitive filesystems (#25853)
When QMK_USERSPACE is empty, the wildcard check in build_keyboard.mk
incorrectly matches user home directories on case-insensitive filesystems
(macOS/Windows), causing USER_PATH to resolve to an absolute path instead
of a relative path.

This only affects users whose username matches their user directory name
(e.g., username 'psycher' with home '/Users/psycher' and QMK user dir
'users/psycher').

Fix by checking if QMK_USERSPACE is non-empty before performing the
wildcard check.
2025-12-05 22:25:48 +00:00
Ivan Gromov
1322922c42
Add kt356 Mini (#25781)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-12-04 12:42:53 -08:00
Ivan Gromov
16dde871d7
Add kt60HS-T v3 (#25822) 2025-12-04 12:42:33 -08:00
Jacek Królikowski
d39015a401
[DOCS] Add keycodes to info.json docs. More precise matrix masking info (#25801) 2025-12-04 12:15:43 +00:00
sigman
bf0b88c423
Adapt MIUNI32 keyboard for VIA configurator (#25803) 2025-12-04 12:14:37 +00:00
tyler
d4f04fe850
Simplify docs for Key Overrides config (#25787) 2025-12-04 12:13:20 +00:00
zvecr
b315b707e6 Merge branch 'develop' 2025-12-01 22:07:33 +00:00
zvecr
e10429baae Merge point for 2025q4 breaking changes. 2025-12-01 22:03:23 +00:00
Joel Challis
0e6b73c9ff
2025q4 develop changelog (#25845) 2025-12-01 21:47:16 +00:00
QMK Bot
d45b967cf2 Merge remote-tracking branch 'origin/master' into develop 2025-12-01 01:46:53 +00:00
Joel Challis
e2bf515df4
Fix python format warnings (#25841) 2025-12-01 12:17:13 +11:00
Joel Challis
2cac8b587f
Remove macos-13 runner from bootstrap testing (#25843) 2025-12-01 12:16:25 +11:00
QMK Bot
d383e93526 Merge remote-tracking branch 'origin/master' into develop 2025-12-01 01:16:10 +00:00
Joel Challis
83b42ea9dc
Update Bootstrap testing triggers (#25842) 2025-12-01 12:15:31 +11:00
QMK Bot
43bbb5e99a
[CI] Format code according to conventions (#25828)
Format code according to conventions
2025-11-30 20:46:22 +00:00
QMK Bot
ee60542bd6 Merge remote-tracking branch 'origin/master' into develop 2025-11-30 19:25:52 +00:00
QMK Bot
6ed61c65dd
[CI] Format code according to conventions (#25827)
Format code according to conventions
2025-11-30 19:25:13 +00:00
Joel Challis
b5dfb2bd1e
Partially skip generating community modules when none enabled (#25819) 2025-11-28 08:29:46 +11:00
QMK Bot
ee44cbdedb Merge remote-tracking branch 'origin/master' into develop 2025-11-27 19:47:31 +00:00
dependabot[bot]
330a8597f8
Bump actions/checkout from 4 to 6 (#25829) 2025-11-28 06:46:53 +11:00
QMK Bot
9acd127cc1 Merge remote-tracking branch 'origin/master' into develop 2025-11-27 13:37:29 +00:00
Nick Brassel
9c2ca00074
QMK CLI Environment bootstrapper (#25038)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Pascal Getreuer <getreuer@google.com>
2025-11-28 00:36:49 +11:00
QMK Bot
9ab8e4cd5a Merge remote-tracking branch 'origin/master' into develop 2025-11-25 10:07:38 +00:00
Danny
594558ec7b
Add Demod LM Rev. 1 (#25793) 2025-11-25 10:07:16 +00:00
andrew morton
5e1b1f5023
Add support for Coffee Break Keyboards' Coffeevan (#25805) 2025-11-25 10:07:01 +00:00
QMK Bot
bbccd8f9cc Merge remote-tracking branch 'origin/master' into develop 2025-11-25 01:32:43 +00:00
Nathan Sunday
cc567c917b
[Keyboard] Add Keenome Keys' "The Grid v2" (#25813)
* Add 'the_grid_v2' to QMK

* Per documentation, formatted keyboard.json and add license to keymap.c

* Update keyboards/keenome_keys/the_grid_v2/keyboard.json

Co-authored-by: Jack Sangdahl <jack@pngu.org>

* Create readme.md for The Grid v2 keyboard

Added detailed readme for The Grid v2 keyboard including setup and bootloader instructions.

* Revise readme for The Grid v2 keyboard

Updated readme with specific hardware details.

---------

Co-authored-by: Jack Sangdahl <jack@pngu.org>
2025-11-24 18:32:03 -07:00
Stephen Ostermiller
1a954e8da5
Reduce tap dance memory usage, move state out of data (#25415)
* Use less tap dance memory.

Use dynamically allocated sparse array for tap dance state, dynamically allocate tap dance state when needed and free it when the tap dance is done.

* new approach

* Use null, check for null

* Reformat with docker

* Use uint8 with idx rather than uint16 with keycode in state

* fix accidental change

* reformat

* Add null check

* add documentation tip suggested by tzarc

* Only allow tap dance state allocation on key down, not on key up

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>

* Only allow tap dance allocation on key down, not on key up

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>

* add user action required section

---------

Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
2025-11-23 22:32:36 +11:00
QMK Bot
c7e17538ee
[CI] Format code according to conventions (#25820) 2025-11-23 22:28:34 +11:00
Julian Schuler
b321789d7b
Fix single key combos activating only once (#25198)
Co-authored-by: Julian Schuler <julianschuler@users.noreply.github.com>
2025-11-23 22:25:59 +11:00
Pascal Getreuer
4015c40ba4
[Bug][Core] Fix Speculative Hold to enable also right-handed RSFT, RCTL by default. (#25797) 2025-11-23 22:24:02 +11:00
Joel Challis
53de903fb8
Better defaulting of {RGB,LED}_MATRIX_DEFAULT_FLAGS (#25785) 2025-11-23 22:21:55 +11:00
Xelus22
fd65390496
[core] add BCD versions of QMK Version (#25804)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-11-23 22:21:13 +11:00
Joel Challis
28a11ff6f7
Fix preference of output file for 'qmk generate-autocorrect-data' (#25818) 2025-11-23 05:02:32 +00:00
Jack Sangdahl
1a7f544e0d
[CLI] Lint error on missing keyboard readme (#25814) 2025-11-22 06:57:58 +00:00
Joel Challis
3e0b22af68
Fix community layout keymap discovery (#25802) 2025-11-22 04:30:27 +00:00
QMK Bot
7edb4d2ed8 Merge remote-tracking branch 'origin/master' into develop 2025-11-21 02:13:50 +00:00
dependabot[bot]
81cc69c2dd
Bump actions/checkout from 5 to 6 (#25807)
Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-21 02:13:14 +00:00
QMK Bot
93274019a9 Merge remote-tracking branch 'origin/master' into develop 2025-11-19 03:51:29 +00:00
andrew morton
0fde9c9cac
[Keyboard] Add Coffee Break Keyboards Acai (#25796)
* Add support for Coffee Break Keyboards Acai

* Apply suggestions from code review

Co-authored-by: Jack Sangdahl <jack@pngu.org>

* Ran qmk format-json

* Misssed one of @waffle87's suggestions

* Misssed another of @waffle87's suggestions

* Try hosting on imgur.com

* Remove empty layers, add boot to layer 2

* Enhance the default keymap

* Use correct keycodes for RGB

---------

Co-authored-by: Jack Sangdahl <jack@pngu.org>
2025-11-18 20:50:47 -07:00
QMK Bot
b708a43730 Merge remote-tracking branch 'origin/master' into develop 2025-11-19 03:46:07 +00:00
Joel Challis
5bb7476400
Short term fix for skip_converter KeyError in 'qmk userspace-add' (#25798) 2025-11-19 03:45:29 +00:00
Joel Challis
8eebc613cf
Merge upstream uf2conv changes (#25786) 2025-11-17 02:24:23 +00:00
QMK Bot
a2adc92066 Merge remote-tracking branch 'origin/master' into develop 2025-11-17 02:12:13 +00:00
yiancar
6242c09f7d
Hyper7 v4 (#25728) 2025-11-17 02:10:59 +00:00
QMK Bot
224ea2eb18 Merge remote-tracking branch 'origin/master' into develop 2025-11-17 02:09:46 +00:00
Ivan Gromov
eb5703d12e
Add imi60-HS (#25773) 2025-11-17 02:09:09 +00:00
QMK Bot
921c0039f4 Merge remote-tracking branch 'origin/master' into develop 2025-11-17 02:07:35 +00:00
Joel Challis
bb2ca21647
Fix detection of hid bootloader flashing tool (#25790) 2025-11-17 02:06:59 +00:00
ploopyco
1a4af3adf9
Add PixArt PAW-3222 mouse sensor driver (#25763) 2025-11-12 09:02:52 +11:00
フィルターペーパー
99b1dc84da
Fix Magic GUI masking logic (#25780) 2025-11-12 09:02:08 +11:00
Joel Challis
98504424b1
Align use of keymap level _kb callbacks (#25774) 2025-11-12 09:00:28 +11:00
Joel Challis
8ec3de0f92
Add return code to qmk userspace-doctor (#25775) 2025-11-12 08:59:06 +11:00
Stefan Kerkmann
c68e4dec10
[Core] suspend: suppress wake up keypress (#23389)
* suspend: suppress wake up keypress

Waking the host from suspend is done by pressing any key on the
keyboard, the regular key codes assigned to the keys are not important
and must not be sent - otherwise they usually end up in password prompts
as ghost characters that have to be deleted again. This commit adds
suppression for all keys pressed at the time of wake up. Once a key is
released it functions as a regular key again.

Signed-off-by: Stefan Kerkmann <karlk90@pm.me>

* suspend: update wake up matrix after wake up delay

If USB_SUSPEND_WAKEUP_DELAY is set, the keyboard sleeps during wake up -
which can be up to multiple seconds. To handle key presses and releases
in that time frame we have to handle the following cases:

1. Key not pressed before suspend, and not pressed after wakeup → do
   nothing (normal case).
2. Key not pressed before suspend, but pressed after wakeup → set the
   wakeup_matrix bit to 1 (so that the press and release events would be
   suppressed).
3. Key pressed before suspend, but not pressed after wakeup → do nothing
   (the release event will be generated on the first matrix_task() call
   after the wakeup).
4. Key pressed before suspend, and still pressed after wakeup → do
   nothing (the release event will be generated some time later).

Signed-off-by: Stefan Kerkmann <karlk90@pm.me>
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>

* keyboards: anavi: macropad8: disable snake and rgb_test effects

...to shrink the binary size.
2025-11-11 23:35:03 +11:00
Chaser Huang
1ddcf57382
[Feature Improvement]add option to keep layer state when recording dynamic macros (#24418)
* feat: add option to keep layer state when recording dynamic macros

* Better option macro name and lint changes
2025-11-11 23:30:42 +11:00
QMK Bot
e06d79e9c6 Merge remote-tracking branch 'origin/master' into develop 2025-11-11 12:22:27 +00:00
QMK Bot
019cba746d Merge remote-tracking branch 'origin/master' into develop 2025-11-11 12:21:26 +00:00
Drashna Jaelre
28eeb92f8e
Add I2C Transmit and Receive function (#25637)
* feat: adds a transmit and receive i2c method

* fix: address the i2c transmit and receive length on u16

* Add AVR/LUFA implementation

Didn't add a progmem version, since that would only apply to receive.
Figured it wasn't worth it, but can add.

* Rearrange order of functions

* Add docs

* Fix doc gen error

* Fix lint issues

* fix more lint issues
2025-11-11 23:02:35 +11:00
Pascal Getreuer
efc5d63383
[Core] Speculative Hold option for mod-taps: hold mods instantly while unsettled. (#25572) 2025-11-11 22:27:12 +11:00
QMK Bot
2af9aac61c Merge remote-tracking branch 'origin/master' into develop 2025-11-08 21:02:36 +00:00
QMK Bot
fb6d7762b9 Merge remote-tracking branch 'origin/master' into develop 2025-11-08 20:49:51 +00:00
Joel Challis
6e35013bc2
Generate CUSTOM_MATRIX = lite without matrix_pins.custom (#25453) 2025-11-08 20:48:48 +00:00
QMK Bot
cf05c7d1e4 Merge remote-tracking branch 'origin/master' into develop 2025-11-08 18:44:13 +00:00
QMK Bot
4b393a1ff5 Merge remote-tracking branch 'origin/master' into develop 2025-11-06 23:43:35 +00:00
Joel Challis
01952bf39a
Implement minimal connection update logic (#25334) 2025-11-06 23:34:23 +00:00
フィルターペーパー
1a991ffd24
Guard remapping logic with MAGIC_ENABLE (#25537)
* Only perform key and mod remapping in keycode_config() and mod_config() when MAGIC_ENABLE is defined.
* If not set, these functions now return the original keycode or modifier unchanged.
* Reduces firmware size, and unnecessary code when MAGIC_ENABLE is not enabled.
* Removed space saving suggestion with magic functions from squeezing AVR documentation
2025-11-06 23:03:28 +00:00
Joel Challis
01d81b9550
Rework converter docs (#18314) 2025-11-06 18:36:07 +00:00
QMK Bot
a00177d172 Merge remote-tracking branch 'origin/master' into develop 2025-11-04 23:06:14 +00:00
QMK Bot
b905c246b5 Merge remote-tracking branch 'origin/master' into develop 2025-11-04 07:07:30 +00:00
Alin Marin Elena
547d75145b
add SteelSeries prime, a stripped down prime+ (#24719) 2025-11-04 14:45:08 +11:00
QMK Bot
f1ec600fac Merge remote-tracking branch 'origin/master' into develop 2025-11-04 00:12:57 +00:00
Pablo Jiménez Mateo
c67e4c2cae
Add classic48 keyboard (#25492)
Co-authored-by: Pablo Jimenez Mateo <pablojimenezmateo@gmail.com>
2025-11-01 22:55:16 -07:00
Tvrd Rad Keyboards
5ba424ca17
Add TRKeyboard TRK2 keyboard (#25754)
Co-authored-by: Jack Sangdahl <jack@pngu.org>
Co-authored-by: Joel Challis <git@zvecr.com>
2025-11-01 22:53:04 -07:00
QMK Bot
e7012f4d9e Merge remote-tracking branch 'origin/master' into develop 2025-11-02 00:07:22 +00:00
Nimish Gåtam
8c93a33cd3
making flowtap timer public so it can be used easily with combos (#25731) 2025-11-01 23:17:50 +00:00
QMK Bot
6aade0ecdc Merge remote-tracking branch 'origin/master' into develop 2025-10-30 20:17:21 +00:00
QMK Bot
ce43c98b65 Merge remote-tracking branch 'origin/master' into develop 2025-10-30 20:06:27 +00:00
Nick Brassel
acd7ad37e6
Update ChibiOS-Contrib. (#25751) 2025-10-28 23:32:31 +11:00
Aleks
cbd55b7890
Restrict mouse timer activation to movement keycodes (#25716)
Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com>
2025-10-27 15:11:57 +11:00
QMK Bot
dadbec4d46 Merge remote-tracking branch 'origin/master' into develop 2025-10-27 01:19:48 +00:00
Filios92
cb3149b7f2
Fix RGB matrix not syncing and turning off properly on timeout (#25467) 2025-10-26 16:47:04 -07:00
QMK Bot
64c84e64c7 Merge remote-tracking branch 'origin/master' into develop 2025-10-23 10:45:10 +00:00
QMK Bot
a05306d153 Merge remote-tracking branch 'origin/master' into develop 2025-10-23 00:56:13 +00:00
QMK Bot
946d651f57 Merge remote-tracking branch 'origin/master' into develop 2025-10-22 15:20:28 +00:00
QMK Bot
7ea7930b8c Merge remote-tracking branch 'origin/master' into develop 2025-10-21 09:58:58 +00:00
QMK Bot
e91938088a Merge remote-tracking branch 'origin/master' into develop 2025-10-20 01:51:25 +00:00
フィルターペーパー
81df543086
Debounce: Deprecate num_rows parameter (#25632) 2025-10-19 03:14:37 +01:00
Boudewijn van Groos
4f21beb715
Fix drv haptics docs by using the correct function name (#25733) 2025-10-18 22:31:52 +01:00
QMK Bot
18051f1723 Merge remote-tracking branch 'origin/master' into develop 2025-10-18 10:18:38 +00:00
QMK Bot
3eb8d3bea3 Merge remote-tracking branch 'origin/master' into develop 2025-10-14 06:36:00 +00:00
Joel Challis
f4068dbfb0
Update STM32F446 default HSE to 8MHz (#25717) 2025-10-13 06:40:45 +01:00
Marek Schmitt
08405df150
Add new macropad Sharkropad (#24961) 2025-10-11 05:45:17 +01:00
QMK Bot
3c751f217a Merge remote-tracking branch 'origin/master' into develop 2025-10-10 22:18:03 +00:00
Jack Sangdahl
9f1a7380ab
Fixup kprepublic/bm60hsrgb/rev2 (#25644)
* Fixup kprepublic/bm60hsrgb/rev2

- Remove RGBLight configuration and throw error if RGBLight & RGB Matrix
  are enabled together - the WS2812 driver cannot be used for RGBLight
  as it is being used by this keyboard's custom RGB Matrix driver
- Migrate RGB Matrix configuration to DD
- Migrate default keymap to JSON
- Use short SPDX license headers

* Fix OOB coordinate
2025-10-08 08:01:26 -06:00
Jack Sangdahl
7dca4e8bda
Fixup kprepublic/bm60hsrgb_iso/rev2 (#25648)
Fixup kprepublic/bm60hsrgb_iso/rev2

- Remove RGBLight configuration and throw error if RGBLight & RGB Matrix
  are enabled together - the WS2812 driver cannot be used for RGBLight
  as it is being used by this keyboard's custom RGB Matrix driver
- Migrate RGB Matrix configuration to DD
- Migrate default keymap to JSON
- Use short SPDX license headers
2025-10-08 08:01:08 -06:00
Jack Sangdahl
0aae222ab6
Fixup kprepublic/bm60hsrgb_poker/rev2 (#25649)
Fixup kprepublic/bm60hsrgb/rev2

- Remove RGBLight configuration and throw error if RGBLight & RGB Matrix
  are enabled together - the WS2812 driver cannot be used for RGBLight
  as it is being used by this keyboard's custom RGB Matrix driver
- Migrate RGB Matrix configuration to DD
- Migrate default keymap to JSON
- Use short SPDX license headers
2025-10-08 08:00:50 -06:00
QMK Bot
475cbd24cf Merge remote-tracking branch 'origin/master' into develop 2025-10-08 03:42:22 +00:00
QMK Bot
81a3249e2c Merge remote-tracking branch 'origin/master' into develop 2025-10-08 02:16:35 +00:00
Pablo Martínez
0550830909
[QP] Minor cleanup and support for RGB888 surface (#25706)
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-10-07 19:10:38 -07:00
QMK Bot
8f86f9794e Merge remote-tracking branch 'origin/master' into develop 2025-10-08 01:16:37 +00:00
QMK Bot
e7d861aea7 Merge remote-tracking branch 'origin/master' into develop 2025-10-07 05:21:16 +00:00
Martin W.
02cf2b56fd
Add Royal Kludge RK61 (#25694) 2025-10-06 17:46:41 +01:00
QMK Bot
5d26dcefa0 Merge remote-tracking branch 'origin/master' into develop 2025-10-06 16:45:06 +00:00
Aidan Smith
c7ed9038d7
E7-V2 Implementation (#25594) 2025-10-06 17:38:27 +01:00
QMK Bot
7a69c714b4 Merge remote-tracking branch 'origin/master' into develop 2025-10-06 16:30:46 +00:00
QMK Bot
074c49ee1c Merge remote-tracking branch 'origin/master' into develop 2025-10-06 16:28:07 +00:00
Pascal Hansjosten
466e0856f5
add durgod venus iso support (#25526) 2025-10-06 17:26:16 +01:00
QMK Bot
60cf3c22f7 Merge remote-tracking branch 'origin/master' into develop 2025-10-06 14:31:39 +00:00
Jack Sangdahl
05355bc49d
Fixup rgbkb/pan (#25678)
Tidy up rgbkb/pan

- Migrate g_led_config to DD and fix coordinates
- Remove RGBLight configuration
- Migrate keymaps to JSON
- Move keymap OLED code to keyboard level
- Remove cutom layout selection logic (post_rules.mk)
- Use short SPDX license headers
2025-10-05 21:06:55 -06:00
QMK Bot
74ac4120db Merge remote-tracking branch 'origin/master' into develop 2025-10-05 23:56:24 +00:00
QMK Bot
9a77ad69e6 Merge remote-tracking branch 'origin/master' into develop 2025-10-05 20:50:42 +00:00
QMK Bot
187119ed7f Merge remote-tracking branch 'origin/master' into develop 2025-10-05 20:46:50 +00:00
James Young
fecfc0f7da
atreus: restore intended matrix implementations (#24082)
* `atreus`: restore intended matrix implementations

PR 24010 inadvertently changed the switch matrix for the
`atreus/astar_mirrored` keyboard in removing the `PCBDOWN` configuration
option, and also made PCB up and down implementations available for all
Atreus variants, which is not intended usage.

This commit restores the intended behaviour, and makes all the keymaps
which are currently present agnostic to hardware variant.
2025-10-05 01:47:45 +01:00
Jack Sangdahl
36fd2437b0
Migrate g_led_config to DD (0-9, A) (#25558) 2025-09-30 17:09:31 +01:00
Pablo Martínez
bbd6e8ab34
[Feature] Implement mod_t packed struct (#25168) 2025-09-30 15:52:43 +01:00
QMK Bot
24bc4aef03 Merge remote-tracking branch 'origin/master' into develop 2025-09-29 22:55:23 +00:00
QMK Bot
532fb2f960 Merge remote-tracking branch 'origin/master' into develop 2025-09-29 19:34:39 +00:00
Joel Challis
6f93a86e6e
Add LED/RGB Matrix flags API docs (#25673) 2025-09-29 20:27:07 +01:00
Joel Challis
0a4c1caf20
Add DD {LED,RGB}_MATRIX_DEFAULT_FLAGS support (#25671) 2025-09-29 20:26:47 +01:00
Joel Challis
883465d9fb
Add generic handling to cycle LED/RGB Matrix flags (#24649) 2025-09-22 00:01:23 +01:00
Ryan
115bf771a8
Custom oled fonts cleanup (#25665) 2025-09-21 21:40:30 +10:00
silvinor
a4b112b1ef
[keyboard] Binepad KnobX1 - refactor x1_layer_led function as weak (#25668)
refactor `x1_layer_led` function as weak
2025-09-19 21:37:18 -06:00
QMK Bot
d1b0397d2f Merge remote-tracking branch 'origin/master' into develop 2025-09-19 02:41:39 +00:00
Joel Challis
46231df62d
Tidy Keebio keyboards (#25653) 2025-09-12 20:00:03 +01:00
Joel Challis
b6310b5a15
Remove encoder resolution where duplicating defaults (#25654) 2025-09-12 16:56:06 +01:00
Joel Challis
d34cade5ab
Generate default encoder resolution for sparse config (#25247) 2025-09-12 13:21:49 +01:00
Joel Challis
cf58a8733d
Add DIP Switch map support to keymap.json (#25431) 2025-09-12 10:23:23 +01:00
Joel Challis
3320e98ccf
Migrate eeconfig_init_kb implementations to config (#25422) 2025-09-12 10:23:16 +01:00
Joel Challis
319da7bfdb
Refactor 40percentclub/ut47 (#25571) 2025-09-12 08:13:12 +01:00
Joel Challis
4a4e4aa083
Remove idobao *_DISABLE_UNDERGLOW behaviour (#25638) 2025-09-12 08:12:48 +01:00
Jack Sangdahl
74b0f054c1
Migrate g_led_config to DD (YZ) (#25650) 2025-09-11 18:34:10 +01:00
QMK Bot
6eee1940e8 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 10:14:38 +00:00
QMK Bot
626cf94653 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 10:04:55 +00:00
QMK Bot
494a691f4c Merge remote-tracking branch 'origin/master' into develop 2025-09-11 08:42:59 +00:00
Christian C. Berclaz
f8d677af88
Add D60B tsangan pcb (#25245)
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2025-09-11 01:19:10 -07:00
QMK Bot
461a1afe57 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 08:17:01 +00:00
QMK Bot
d4fb67fd5b Merge remote-tracking branch 'origin/master' into develop 2025-09-11 08:16:20 +00:00
QMK Bot
3cd8dd6b25 Merge remote-tracking branch 'origin/master' into develop 2025-09-11 00:45:15 +00:00
Jack Sangdahl
a4d10e9f64
Refactor 40percentclub/gherkin (#25608) 2025-09-10 16:33:38 -07:00
Jack Sangdahl
286947b6fa
Refactor 0xcb/splaytoraid (#25609) 2025-09-10 16:33:12 -07:00
Jack Sangdahl
f12902eb16
Refactor 1upkeyboards/sweet16v2 (#25610) 2025-09-10 16:32:48 -07:00
QMK Bot
0351b598f9 Merge remote-tracking branch 'origin/master' into develop 2025-09-10 12:29:59 +00:00
QMK Bot
c113250c4e Merge remote-tracking branch 'origin/master' into develop 2025-09-10 08:53:02 +00:00
フィルターペーパー
633479ced5
Restructure Pixel Rain interval code (#25516)
Co-authored-by: Joel Challis <git@zvecr.com>
2025-09-10 01:41:29 -07:00
Jack Sangdahl
a91de72246
Migrate g_led_config to DD (K7) (#25616) 2025-09-10 09:14:04 +01:00
QMK Bot
50edd425f7 Merge remote-tracking branch 'origin/master' into develop 2025-09-10 08:12:23 +00:00
QMK Bot
514175848e Merge remote-tracking branch 'origin/master' into develop 2025-09-10 01:45:28 +00:00
QMK Bot
7caef16edd Merge remote-tracking branch 'origin/master' into develop 2025-09-10 01:44:04 +00:00
QMK Bot
ff8db0449e Merge remote-tracking branch 'origin/master' into develop 2025-09-09 21:51:51 +00:00
QMK Bot
7772f47f04 Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:42:16 +00:00
QMK Bot
ab61d9cb51 Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:35:52 +00:00
QMK Bot
649bbdeaba Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:34:48 +00:00
Ryan
eda39f4356
Update default OLED font (#25565) 2025-09-09 17:34:33 +01:00
QMK Bot
c3ba5de928 Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:28:48 +00:00
QMK Bot
592ee1b57f Merge remote-tracking branch 'origin/master' into develop 2025-09-09 16:27:53 +00:00
Jack Sangdahl
db9b295aa7
Migrate g_led_config to DD (L) (#25617) 2025-09-09 11:50:36 +01:00
Jack Sangdahl
3934a7f3c8
Migrate g_led_config to DD (I) (#25600) 2025-09-09 10:18:16 +01:00
Jack Sangdahl
ed2de21603
Migrate g_led_config to DD (M1) (#25618) 2025-09-09 10:10:34 +01:00
Jack Sangdahl
04978d490a
Migrate g_led_config to DD (M2) (#25619) 2025-09-09 10:09:38 +01:00
Jack Sangdahl
7186a63172
Migrate g_led_config to DD (M3) (#25620) 2025-09-09 10:09:14 +01:00
Jack Sangdahl
ff1900190c
Migrate g_led_config to DD (NO) (#25621) 2025-09-09 10:08:42 +01:00
Jack Sangdahl
2818085d3f
Migrate g_led_config to DD (P) (#25622) 2025-09-09 10:08:20 +01:00
Jack Sangdahl
d17671cd23
Migrate g_led_config to DD (QR) (#25623) 2025-09-09 10:07:47 +01:00
Jack Sangdahl
8f22831f01
Migrate g_led_config to DD (S) (#25624) 2025-09-09 10:07:06 +01:00
Jack Sangdahl
6c96bb5a5a
Migrate g_led_config to DD (TUW) (#25625) 2025-09-09 10:06:12 +01:00
Jack Sangdahl
177ff71d0c
Migrate g_led_config to DD (H) (#25599) 2025-09-09 10:04:40 +01:00
Jack Sangdahl
c1b428bb4e
Migrate g_led_config to DD (JK1) (#25601) 2025-09-09 10:03:52 +01:00
Jack Sangdahl
0828fc4b6f
Migrate g_led_config to DD (K2) (#25602) 2025-09-09 10:03:13 +01:00
Jack Sangdahl
1e8de37aa0
Migrate g_led_config to DD (K3) (#25603) 2025-09-09 10:02:29 +01:00
Jack Sangdahl
9cd3080e22
Migrate g_led_config to DD (K4) (#25605) 2025-09-09 10:02:15 +01:00
Jack Sangdahl
ceefde5ec8
Migrate g_led_config to DD (K5) (#25606) 2025-09-09 10:02:01 +01:00
Jack Sangdahl
3a29cdbd7d
Migrate g_led_config to DD (K6) (#25607) 2025-09-09 10:01:17 +01:00
Jack Sangdahl
2d5cb23503
Migrate g_led_config to DD (G) (#25598) 2025-09-09 10:00:32 +01:00
Jack Sangdahl
6aa85699a5
Migrate g_led_config to DD (E, F) (#25561) 2025-09-09 09:59:42 +01:00
Jack Sangdahl
330d195f9a
Migrate g_led_config to DD (D) (#25560) 2025-09-09 09:58:45 +01:00
Jack Sangdahl
4b1b83f42f
Migrate g_led_config to DD (B, C) (#25559) 2025-09-09 09:58:29 +01:00
QMK Bot
f749dedb0d Merge remote-tracking branch 'origin/master' into develop 2025-09-08 06:57:41 +00:00
QMK Bot
e01313e7d0 Merge remote-tracking branch 'origin/master' into develop 2025-09-07 17:25:52 +00:00
フィルターペーパー
4bd5c033c3
Refactor debounce algorithm with static allocation (#25515)
* Refactor debounce counters with direct indexing

* Refactor code to use array indexing for debounce_counters
* Use global MATRIX_ROW_SHIFTER macro

* Refactor debounce algorithm with static allocation

* Converted arrays to static allocation
* Standardised use of MATRIX_ROWS_PER_HAND for array sizing
* Added Doxygen comments for primary debounce functions
* Removed debounce_free()

* Rewrite sym_defer_pr

* Modernise code using sym_defer_pk as template
* Format consistency with other current algorithms

* Use shorter SPDX-License-Identifier

* Remove ChibiOS core memory manager guard
* Keep type definition within DEBOUNCE guard

* Add change log

* Minor optimisation refactor

* Pre-calculate row_offset in per-key matrix loops
* Add inline compiler hints
* Improve readability with blank lines

* Limit elapsed time to the maximum debounce value

* Apply suggestions from code review

Declare counters with "DEBOUNCE_ELAPSED"

Co-authored-by: Joel Challis <git@zvecr.com>

* Update change log to new breaking change date

---------

Co-authored-by: Joel Challis <git@zvecr.com>
2025-09-07 13:34:05 +01:00
QMK Bot
5830b1b5e3 Merge remote-tracking branch 'origin/master' into develop 2025-09-07 12:09:44 +00:00
Ryan
bcc546aa3f
Update USBaspLoader ISP instructions (#25590) 2025-09-07 13:05:34 +01:00
Joel Challis
19527e8399
Remove duplication of RP2040 config defaults (#25563) 2025-09-06 14:48:07 -07:00
フィルターペーパー
d8ce8cd204
Simplify hue calculation in raindrops animation (#25587) 2025-09-06 14:43:01 -07:00
フィルターペーパー
248d7c1d6d
Simplify tap_code16_delay (#25595)
* Replaced for-loop with single wait_ms(delay) call
* Improve code consistency with tap_code_delay
2025-09-06 10:04:42 +01:00
Nick Brassel
9455c6adec
Branch point for 2025q4 breaking changes 2025-09-06 17:57:39 +10:00
Nick Brassel
6619ea4441
Merge branch 'master' into develop 2025-09-06 17:57:11 +10:00
1323 changed files with 38030 additions and 19043 deletions

430
.github/copilot-instructions.md vendored Normal file
View file

@ -0,0 +1,430 @@
---
applyTo: "**"
excludeAgent:
- "coding-agent"
---
# GitHub Copilot Instructions for QMK Pull Request Review
This document provides automated review guidance based on the [QMK PR Checklist](https://docs.qmk.fm/pr_checklist) and it is intended only for use by GitHub Copilot code-review agent during pull request reviews.
## General PR Requirements
### Branch and Submission Standards
- **Source Branch Policy**: Verify PR is NOT submitted from submitter's own `master` branch
- Flag if submitter is using their own `master` branch as source
- Suggest using feature branches instead for cleaner fork management
- **Target Branch Policy**:
- **New keyboard additions** → `master` branch (new folders under `keyboards/`)
- **All other changes** → `develop` branch:
- Keyboard updates, refactors, or moves
- Core code changes
- Data-driven configuration migrations
- Any modifications to existing keyboards
- **PR Scope**: PRs should contain the smallest set of modifications for a single change
- Flag PRs that modify multiple keyboards simultaneously
- Suggest splitting large PRs into focused, incremental changes
- **Merge Conflicts**: Check for unresolved merge conflicts
### File Naming and Structure
- **Lowercase Requirement**: All new directories and filenames must be lowercase
- Exception: Upstream sources with original uppercase (LUFA, ChibiOS)
- Exception: Core files with valid justification
- **Reject**: Board designer preference for uppercase is NOT valid justification
### License Headers
- **Required**: Valid license headers on all `*.c` and `*.h` files
- **Recommended**: GPL2/GPL3 for consistency
- **Format**: Check for proper GPL2+ header or SPDX identifier
```c
// Copyright 2024 Your Name (@yourgithub)
// SPDX-License-Identifier: GPL-2.0-or-later
```
- **Exception**: Simple assignment-only `rules.mk` files don't need headers
- **Flag**: Missing or ambiguous license headers (blocks merge)
### QMK Best Practices
- **Include Guards**: Use `#pragma once` instead of `#ifndef` guards in headers
- **Abstractions Required**: No low-level GPIO/I2C/SPI functions
- Must use QMK abstractions (flag direct hardware access)
- **Timing Functions**:
- Use `wait_ms()` instead of `_delay_ms()`
- Remove `#include <util/delay.h>`
- Use `timer_read()`, `timer_read32()` from `timer.h`
- **New Abstractions**: If proposing new abstraction, suggest:
1. Prototype in own keyboard first
2. Discuss with QMK Collaborators on Discord
3. Refactor as separate core change
4. Remove the keyboard-specific implementation from board
---
## Keymap PR Reviews
**Scope**: These rules apply to files within `keyboards/*/keymaps/*` subdirectories.
### Note on Personal Keymaps
- **Policy Change**: Personal keymap submissions no longer accepted
- **Permitted**: Vendor-specific keymaps only
- Naming convention: `default_${vendor}` (e.g., `default_clueboard`)
- Can be more feature-rich than stock `default` keymaps
### Keymap Code Standards
- **Includes**: `#include QMK_KEYBOARD_H` preferred over specific board files
- **Enums**: Prefer layer enums to `#define`s
- **Custom Keycodes**: First entry must be `QK_USER`
- **Formatting**: Check spacing alignment on commas and keycodes (spaces, not tabs)
- **VIA**: Keymaps should NOT enable VIA
- VIA keymaps belong in [VIA QMK Userspace](https://github.com/the-via/qmk_userspace_via)
---
## Keyboard PR Reviews
**Scope**: These rules apply to keyboard-level files in `keyboards/*` directories, excluding files within the `keymaps/` subdirectories. This includes:
- `info.json` or `keyboard.json` (keyboard root or variant level)
- `readme.md` (keyboard level)
- `rules.mk` (keyboard level)
- `config.h` (keyboard level, not keymap level)
- `<keyboard>.c` and `<keyboard>.h` files
- Hardware configuration files (`halconf.h`, `mcuconf.h`, `chconf.h`)
### Branch Targeting
- **New Keyboards**: Target `master` branch
- New additions to `keyboards/` folder submit to `master`
- **Keyboard Moves**: Must target `develop` branch
- Check `data/mappings/keyboard_aliases.hjson` is updated for moves
- **Keyboard Updates/Refactors**: Must target `develop` to reduce merge conflicts
- **Data Driven Migration**: Must target `develop`
### info.json and keyboard.json Requirements
- **Data-Driven Configuration**: Encourage maximum use of `info.json` and `keyboard.json` schema features
- **Schema Validation**: All `info.json` and `keyboard.json` files must validate against `data/schemas/keyboard.jsonschema`
- Use QMK CLI: `qmk lint -kb <keyboard_name>` to validate
- Schema defines required fields, data types, and valid values
- Check for schema validation errors before submitting PR
- **Mandatory Elements**:
- Valid URL
- Valid maintainer
- Valid USB VID/PID and device version
- Displays correctly in Configurator (Ctrl+Shift+I to preview)
- `layout` definitions include matrix positions
- Standard layout definitions where applicable
- Community Layout macro names when applicable
- Microcontroller and bootloader specified
- Diode direction (if not using direct pins)
- **Layout Naming**:
- Single layout: Use `LAYOUT` or community layout name
- Multiple layouts: Include `LAYOUT_all` + alternate names
- Prefer community layout names (e.g., `LAYOUT_tkl_ansi`, `LAYOUT_ortho_4x4`)
- **Configuration in info.json or keyboard.json** (when applicable):
- Direct pin configuration
- Backlight, Split keyboard, Encoder, Bootmagic configs
- LED Indicator, RGB Light, RGB Matrix configs
- **Format**: Run `qmk format-json -i` before submitting
### USB VID/PID Uniqueness
VID+PID combination must be unique across all keyboards. Individual VID or PID values can be reused with different partners.
**Validation Steps:**
1. Extract VID and PID from keyboard.json/info.json in the PR
2. Search for existing usage: `grep -r '"vid".*"0xVVVV"' keyboards/ --include="*.json" | grep -l '"pid".*"0xPPPP"'`
3. If results found: Check if BOTH VID AND PID match in same file
- Both match = **COLLISION** - request different PID
- Only one matches = **OK** - different keyboards can share individual values
4. For keyboard variants/revisions under same keyboard folder:
- Different PID recommended for functionally different variants
- Same PID acceptable if revisions only differ in hardware routing/pin assignments
**Quick Reference:**
- Same PID + Different VID = Valid
- Same VID + Different PID = Valid
- Same VID + Same PID = Invalid
**Review Response:**
For collision:
```
VID+PID collision: 0xVVVV:0xPPPP already used by keyboards/[path]/file.json
+Please assign a different PID. VID can remain the same.
```
For uniqueness confirmed:
```
VID+PID validation: 0xVVVV:0xPPPP is unique (no collisions found)
```
### readme.md Requirements
- **Template**: Must follow [official template](https://github.com/qmk/qmk_firmware/blob/master/data/templates/keyboard/readme.md)
- **Flash Command**: Present with `:flash` at end
- **Hardware Link**: Valid availability link (unless handwired)
- Private groupbuys acceptable
- One-off prototypes will be questioned
- Open-source should link to files
- **Reset Instructions**: Clear bootloader mode instructions
- **Images Required**:
- Keyboard and PCB photos preferred
- Must be hosted externally (imgur, etc.)
- Direct image links required (not preview pages)
- Example: `https://i.imgur.com/vqgE7Ok.jpg` not `https://imgur.com/vqgE7Ok`
### rules.mk Standards
- **Removed Items**:
- `MIDI_ENABLE`, `FAUXCLICKY_ENABLE`, `HD44780_ENABLE`
- Size comments like `(-/+size)`
- Alternate bootloader lists if one specified
- MCU parameter re-definitions matching defaults in `mcu_selection.mk`
- **Comment Updates**: Change bootloader comments to generic
- **Forbidden Features at Keyboard Level** (these belong in keymap-level `rules.mk` only):
- `COMBO_ENABLE`
- `ENCODER_MAP_ENABLE`
### config.h Standards (Keyboard Level)
- **Prohibited**:
- `#define DESCRIPTION`
- Magic Key Options, MIDI Options, HD44780 configuration
- User preference `#define`s (belong in keymap)
- Re-defining default values (`DEBOUNCE`, RGB settings)
- Copy/pasted comment blocks explaining features
- Commented-out unused defines
- `#include "config_common.h"`
- `#define MATRIX_ROWS/COLS` (unless custom matrix)
- **Minimal Code**: Only critical board boot code required
- **No Vial**: Vial-related files/changes not accepted
### Keyboard Implementation Files
#### `<keyboard>.c`
- **Remove Empty Functions**: Delete empty or commented-out weak-defined functions
- `xxxx_xxxx_kb()`, `xxxx_xxxx_user()` implementations
- **Migration**: `matrix_init_board()` → `keyboard_pre_init_kb()`
- **Custom Matrix**: Use `lite` variant when possible for standard debounce
- `CUSTOM_MATRIX = lite` preferred
- Full custom matrix (`yes`) requires justification
- **LED Indicators**: Prefer Configuration Options over custom `led_update_*()` implementations
- **Hardware Configuration**: Basic functionality for OLED, encoders, etc. at keyboard level
#### `<keyboard>.h`
- **Include**: `#include "quantum.h"` at top
- **Layout Macros**: Move to `info.json` or `keyboard.json` (no longer in header)
### Default Keymap Standards
**Scope**: These rules specifically apply to files within `keyboards/*/keymaps/default/` directories.
- **Pristine Requirement**: Bare minimum clean slate
- No custom keycodes
- No advanced features (non-exhaustive list of examples: tap dance, macros)
- Basic mod taps and home row mods acceptable when necessary
- Standard layouts preferred -- see examples in `layouts/default/` and `layouts/community/`
- **Removed Examples**: Delete `QMKBEST`/`QMKURL` macros
- **Tri Layer**: Use Tri Layer feature instead of manual `layer_on/off()` + `update_tri_layer()`
- **Encoder Map**: Use encoder map feature, `encoder_update_user()` may not be present
- **No VIA**: Default keymap should not enable VIA
- **Additional Keymaps**: Example/bells-and-whistles keymaps acceptable in same PR (separate from default)
### Prohibited Files
- **No VIA JSON**: Belongs in [VIA Keyboard Repo](https://github.com/the-via/keyboards)
- **No KLE JSON**: Not used within QMK
- **No Cross-Keyboard Sources**: Don't include files from other keyboard vendors
- Exception: Core files (e.g., `drivers/sensors/pmw3360.c`)
- Use of vendor-specific code (e.g., `wilba_tech/wt_main.c`) only when keyboard exists in the same enclosing vendor folder (e.g. a `wilba_tech` keyboard)
- Multi-board code is candidate for core refactoring when intended for use by multiple vendors
### Wireless Keyboards
- **Policy**: Wireless/Bluetooth PRs rejected without complete wireless code
- Wireless code may not include anything resembling precompiled data such as `*.a` files or other libraries
- Firmware blobs are not permitted in raw form or as compiled C-style arrays either.
- GPL2+ license requires full source disclosure
- Historically abused for VIA compatibility without releasing sources
- PRs without wireless capability will be held indefinitely
- Existing merged wireless boards from same vendor held until sources provided
### ChibiOS-Specific Requirements
- **Board Definitions**: Strong preference for existing ChibiOS board definitions
- Use equivalent Nucleo boards when possible
- Example: STM32L082KZ can use `BOARD = ST_NUCLEO64_L073RZ`
- QMK is eliminating custom board definitions due to maintenance burden
- **New Board Definitions**:
- Must NOT be embedded in keyboard PR
- Submit as separate Core PR
- `board.c` must have standard `__early_init()` and empty `boardInit()`
- Migrate code intended for `__early_init()` → keyboard-local `early_hardware_init_pre/post()`
- Migrate code intended for `boardInit()` → keyboard-local `board_init()`
---
## Core PR Reviews
### Targeting and Scope
- **Branch**: All core PRs must target `develop` branch
- **Single Focus**: Smallest set of changes per PR
- PRs with multiple areas will be asked to split
- Keyboard/keymap changes only if affecting base builds or default-like keymaps
- Keymap modifications (non-default) should be followup PR after core merge
- Large refactoring PRs affecting other keymaps raised separately
### Testing Requirements
- **New Hardware Support**: Requires test keyboard under `keyboards/handwired/onekey`
- New MCUs: Add child keyboard targeting new MCU for build verification
- New hardware (displays, matrix, peripherals): Provide associated keymap
- Exception: If existing keymap can leverage functionality (consult Collaborators)
- **Callbacks**: New `_kb`/`_user` callbacks must return `bool` for user override
- **Unit Tests**: Strongly recommended, may be required
- Critical code areas (keycode pipeline) will require tests
- Boost confidence in current and future correctness
### Code Quality
- **Subjective Review**: Other requirements at QMK Collaborators' discretion
- **Documentation**: Core changes should be well-documented
---
## Automated Review Checklist
When reviewing PRs, check the following systematically:
### File Changes Review
1. **License headers** on all C/H files (GPL2+ preferred, others must be GPL2+ compatible, SPDX format preferred)
2. **File naming** lowercase (flag exceptions needing justification)
3. **Include guards** use `#pragma once`
4. **No low-level hardware access** (GPIO, I2C, SPI direct register writes)
5. **Timing abstractions** (`wait_ms()`, `timer_read()` usage)
### info.json and keyboard.json Validation
1. **Schema Compliance**: `keyboard.json` and `info.json` files validate against `data/schemas/keyboard.jsonschema`
- Both files are identical syntax, however the `keyboard.json` dictates a buildable target, `info.json` does not
- Run `qmk lint -kb <keyboard>` to check schema validation
- Check for proper data types (strings, integers, arrays, objects)
- Verify required fields are present
- Ensure enum values match allowed options in schema
2. All mandatory fields present and valid
3. `qmk format-json -i` has been run (formats and validates)
4. Layout macros moved from headers
5. Community layout names used where applicable
### rules.mk Cleanup
1. Deprecated features removed
2. No size comments
3. No keymap-only features at keyboard level
4. No redundant MCU parameter definitions
### config.h Cleanup
1. No `DESCRIPTION`, `config_common.h`, or prohibited includes
2. No default value re-definitions
3. No commented-out defines or feature documentation blocks
4. No user preference defines at keyboard level
### Keymap Quality
1. Default keymaps are pristine (no custom keycodes/advanced features)
2. No `QMKBEST`/`QMKURL` macros
3. Encoder map feature used instead of `encoder_update_user()`
4. Tri Layer feature used for multi-layer access
5. No VIA enabled in default keymap
### Documentation
1. readme.md follows template
2. Flash command present with `:flash`
3. Reset instructions clear
4. External image hosting (direct links)
5. Valid hardware availability link
### Code Organization
1. Empty weak-defined functions removed from `<keyboard>.c`
2. Proper migration of init functions
3. No cross-vendor source files
4. No VIA/KLE JSON files
### Branch and Scope
1. Not submitted from submitter's own `master` branch (use feature branches)
2. PR is focused on single change
3. Targets correct branch:
- `master` for new keyboard additions
- `develop` for keyboard updates/refactors/moves and core changes
4. No merge conflicts
---
## Review Response Templates
### For source master branch usage:
```
⚠️ This PR appears to be submitted from your own `master` branch. For future PRs, we recommend using feature branches instead of committing to your `master`. This makes it easier to keep your fork updated and manage multiple PRs.
See: [Best Practices: Your Fork's Master](https://docs.qmk.fm/newbs_git_using_your_master_branch)
```
### For incorrect target branch:
```
❌ This PR targets the wrong branch:
- **New keyboard additions** should target `master`
- **Keyboard updates/refactors/moves** should target `develop`
- **Core changes** should target `develop`
Please change the target branch accordingly.
```
### For missing license headers:
```
❌ Missing GPL-compatible license headers on the following files:
- [list files]
Please add GPL2+ headers (GPL2/GPL3 recommended). Example:
\`\`\`c
// Copyright 2024 Your Name (@yourgithub)
// SPDX-License-Identifier: GPL-2.0-or-later
\`\`\`
```
### For non-lowercase filenames:
```
❌ The following files/directories must be lowercase:
- [list files]
Exception: Only valid if from upstream sources (LUFA, ChibiOS) or justified by core consistency.
```
### For config.h violations:
```
⚠️ Found prohibited config.h elements:
- [list specific issues: DESCRIPTION, default value re-definitions, etc.]
Please remove these and refer to [Data Driven Configuration](https://docs.qmk.fm/data_driven_config).
```
### For info.json or keyboard.json issues:
```
⚠️ info.json or keyboard.json needs attention:
- [list missing mandatory fields]
- Please run: \`qmk format-json -i path/to/info.json\` (or keyboard.json)
- Validate with: \`qmk lint -kb <keyboard_name>\`
```
### For schema validation errors:
```
❌ Schema validation failed for info.json or keyboard.json:
- [list specific validation errors from schema]
- Check `data/schemas/keyboard.jsonschema` for valid field definitions
- Common issues:
- Invalid data types (e.g., string instead of integer)
- Missing required fields
- Invalid enum values
- Incorrectly formatted pin definitions
```
### For non-pristine default keymap:
```
⚠️ Default keymap should be pristine (clean slate for users):
- Remove: [custom keycodes/tap dance/macros/etc.]
- Keep it minimal with standard layouts where possible
Consider moving advanced features to a separate example keymap.
```
---
## Notes for GitHub Copilot
- Focus reviews on **objective checklist items** that can be automatically verified
- Flag **definite violations** with ❌
- Suggest improvements for **recommendations** with ⚠️
- **Provide specific file/line references** when flagging issues
- **Link to relevant QMK documentation** for each issue
- **Prioritize blocking issues** (license, merge conflicts, branch policy)
- **Be constructive**: Suggest fixes, not just problems
- **Acknowledge trade-offs**: Some guidelines have valid exceptions
This is meant as a **first-pass review** to catch common issues before human review. Complex architectural decisions, code quality, and subjective assessments still require human QMK Collaborator review.

View file

@ -25,7 +25,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
fetch-depth: 1
persist-credentials: false

View file

@ -4,7 +4,7 @@ permissions: {}
on:
schedule:
- cron: "*/5 * * * *"
- cron: "*/30 * * * *"
jobs:
automatic_approve:

View file

@ -28,7 +28,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
fetch-depth: 0

289
.github/workflows/bootstrap_testing.yml vendored Normal file
View file

@ -0,0 +1,289 @@
name: Bootstrap Script Testing
on:
push:
branches: [master, develop, xap]
paths:
- 'util/env-bootstrap.sh'
- '.github/workflows/bootstrap_testing.yml'
pull_request:
paths:
- 'util/env-bootstrap.sh'
- '.github/workflows/bootstrap_testing.yml'
workflow_dispatch:
permissions:
contents: read
jobs:
prep:
runs-on: ubuntu-latest
outputs:
any_changed: ${{ steps.file_changes.outputs.any_changed }}
steps:
- name: Get changed files
id: file_changes
if: ${{ github.event_name == 'pull_request' }}
uses: tj-actions/changed-files@v47
with:
use_rest_api: true
files: |
util/env-bootstrap.sh
.github/workflows/bootstrap_testing.yml
bootstrap-test-linux:
name: Bootstrap (Linux)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
distribution:
# Ubuntu/Debian based
- debian:11
- debian:12
- debian:13
- ubuntu:20.04
- ubuntu:22.04
- ubuntu:24.04
# RHEL/CentOS/Fedora based
- fedora:41
- fedora:42
- fedora:43
- rockylinux:8
- rockylinux:9
- rockylinux/rockylinux:10
- almalinux:8
- almalinux:9
- almalinux:10
# OpenSUSE based (we skip Tumbleweed as it has issues with package versions between pattern installs and other dependencies preinstalled into the base container)
- opensuse/leap:latest
# Gentoo-based
- gentoo/stage3:latest
# Arch based
- archlinux:latest
- cachyos/cachyos:latest
- manjarolinux/base:latest
container:
image: ${{ matrix.distribution }}
options: --privileged
steps:
- name: Install base dependencies
run: |
# Attempt to run the package installation up to 10 times to mitigate transient network issues
for n in $(seq 1 10); do
{
echo "Attempt #$n of 10 to install base dependencies:"
case "${{ matrix.distribution }}" in
*ubuntu*|*debian*)
apt-get update
apt-get install -y sudo git passwd
;;
*fedora*|*rockylinux*|*almalinux*)
dnf install -y sudo git passwd findutils # findutils=xargs
;;
*suse*)
zypper --non-interactive refresh
zypper --non-interactive install sudo git shadow findutils # findutils=xargs
;;
*gentoo*)
emerge-webrsync
emerge --noreplace --ask=n sudo dev-vcs/git shadow findutils # findutils=xargs
;;
*archlinux*|*cachyos*|*manjaro*)
pacman -Syu --noconfirm
pacman -S --noconfirm sudo git
;;
esac
} && break || sleep 10
done
# Fix PAM configuration for sudo in containers
# Fix /etc/shadow permissions - common issue in container environments
chmod 640 /etc/shadow || chmod 400 /etc/shadow || true
# Disable problematic PAM modules that commonly fail in RHEL-like containers
sed -i 's/^session.*pam_systemd.so/#&/' /etc/pam.d/sudo || true
sed -i 's/^session.*pam_loginuid.so/#&/' /etc/pam.d/sudo || true
# Ensure proper sudoers configuration
echo 'Defaults !requiretty' >> /etc/sudoers
echo 'Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"' >> /etc/sudoers
- name: Checkout repository
uses: actions/checkout@v6
with:
fetch-depth: 1
submodules: recursive
path: qmk_firmware
- name: Create test user
run: |
# Create a test user for the bootstrap script
useradd -m -s /bin/bash -U testuser
echo 'testuser:testpassword' | chpasswd || true
# Configure passwordless sudo
echo "root ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers # some distros complain about root not being in sudoers
echo "testuser ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
# Test sudo functionality
sudo -u testuser whoami || echo "Sudo test failed, but continuing..."
- name: Move QMK repository to test user home
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git -C qmk_firmware remote add upstream https://github.com/qmk/qmk_firmware.git
# Move the QMK repository to the test user's home directory
mv qmk_firmware /home/testuser/qmk_firmware
chown -R testuser:testuser /home/testuser/qmk_firmware
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Ensure the bootstrap script can access sudo
sudo -u testuser --preserve-env=GITHUB_TOKEN bash -c "
export CONFIRM=1
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
cd /home/testuser
bash /home/testuser/qmk_firmware/util/env-bootstrap.sh
"
- name: Install dependencies
run: |
sudo -u testuser bash -c "
/home/testuser/.local/share/uv/tools/qmk/bin/python -m pip install -r /home/testuser/qmk_firmware/requirements.txt
"
- name: Test QMK CLI
run: |
sudo -u testuser bash -c "
export PATH=/home/testuser/.local/bin:\$PATH
cd /home/testuser
qmk setup -y -H /home/testuser/qmk_firmware # setup implies doctor, no need to run it separately
cd /home/testuser/qmk_firmware
qmk mass-compile -j $(nproc) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset -p || touch .failed # Compile a bunch of different platforms
"
cd /home/testuser/qmk_firmware
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1
bootstrap-test-macos:
name: Bootstrap (macOS)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
strategy:
fail-fast: false
matrix:
os:
- macos-14 # Apple Silicon ARM64
- macos-15 # Apple Silicon ARM64
- macos-15-intel # Intel x64
- macos-26 # Apple Silicon ARM64
runs-on: ${{ matrix.os }}
steps:
- name: Checkout repository
uses: actions/checkout@v6
with:
fetch-depth: 1
submodules: recursive
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git remote add upstream https://github.com/qmk/qmk_firmware.git
# Run the bootstrap script
export CONFIRM=1
sh ./util/env-bootstrap.sh
- name: Install dependencies
run: |
$HOME/.local/share/uv/tools/qmk/bin/python -m pip install -r requirements.txt
- name: Test QMK CLI
run: |
# Add QMK CLI to PATH (bootstrap script installs it to ~/.local/bin on macOS)
export PATH="$HOME/.local/bin:$PATH"
qmk setup -y -H . # setup implies doctor, no need to run it separately
qmk mass-compile -j $(sysctl -n hw.ncpu) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset || touch .failed # Compile a bunch of different platforms
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1
bootstrap-test-windows:
name: Bootstrap (Windows)
needs: prep
if: ${{ github.event_name != 'pull_request' || needs.prep.outputs.any_changed == 'true' }}
strategy:
fail-fast: false
matrix:
msys-variant:
- mingw64
- clang64
- ucrt64
runs-on: windows-latest
defaults:
run:
shell: msys2 {0}
steps:
- name: Install MSYS2
uses: msys2/setup-msys2@v2
with:
msystem: ${{ matrix.msys-variant }}
pacboy: >-
git:
- name: Checkout repository
uses: actions/checkout@v6
with:
fetch-depth: 1
submodules: recursive
- name: Run bootstrap script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Add upstream remote to the cloned repository so `qmk doctor` doesn't flag a warning
git remote add upstream https://github.com/qmk/qmk_firmware.git
# Run the bootstrap script
export CONFIRM=1
sh ./util/env-bootstrap.sh
- name: Install dependencies
run: |
/opt/uv/tools/qmk/Scripts/python -m pip install -r requirements.txt
- name: Test QMK CLI
run: |
# Add QMK CLI to PATH (bootstrap script installs it to /opt/uv/tools/bin on Windows MSYS2)
export PATH="/opt/uv/tools/bin:$PATH"
qmk setup -y -H . # setup implies doctor, no need to run it separately
qmk mass-compile -j $(nproc) -e DUMP_CI_METADATA=yes -f 'keyboard_name==*onekey*' -km reset || touch .failed # Compile a bunch of different platforms
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
[ ! -e .failed ] || exit 1

View file

@ -35,17 +35,15 @@ jobs:
slice_length: ${{ steps.generate_slice_length.outputs.slice_length }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v6
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Determine concurrency
id: generate_slice_length
@ -82,12 +80,12 @@ jobs:
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Download firmwares
uses: actions/download-artifact@v6
uses: actions/download-artifact@v7
with:
pattern: firmware-*
path: .

View file

@ -27,17 +27,15 @@ jobs:
targets: ${{ steps.generate_targets.outputs.targets }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v6
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Generate build targets
id: generate_targets
@ -62,7 +60,7 @@ jobs:
echo "targets=$(jq -c 'keys' targets.json)" >> $GITHUB_OUTPUT
- name: Upload targets json
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v7
with:
name: targets-${{ inputs.keymap }}
path: targets.json
@ -79,20 +77,18 @@ jobs:
target: ${{ fromJson(needs.generate_targets.outputs.targets) }}
steps:
- name: Install prerequisites
run: |
apt-get update
apt-get install -y jq
- name: Disable safe.directory check
run: |
git config --global --add safe.directory '*'
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v6
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Get target definitions
uses: actions/download-artifact@v6
uses: actions/download-artifact@v7
with:
name: targets-${{ inputs.keymap }}
path: .
@ -109,10 +105,15 @@ jobs:
continue-on-error: true
run: |
export NCPUS=$(( $(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null) -1 ))
qmk mass-compile -t -j $NCPUS -e DUMP_CI_METADATA=yes $(jq -r '.["${{ matrix.target }}"].targets' targets.json) || touch .failed
targets=$(jq -r '.["${{ matrix.target }}"].targets' targets.json | tr ' ' '\n' | sort)
if [ -z "${targets}" ]; then
echo "Zero build targets detected"
exit 0
fi
qmk mass-compile -t -j $NCPUS -e DUMP_CI_METADATA=yes $targets || touch .failed
- name: Upload binaries
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v7
with:
name: firmware-${{ inputs.keymap }}-${{ matrix.target }}
if-no-files-found: ignore
@ -136,17 +137,17 @@ jobs:
steps:
- name: Checkout QMK Firmware
uses: actions/checkout@v5
uses: actions/checkout@v6
- name: Download firmwares
uses: actions/download-artifact@v6
uses: actions/download-artifact@v7
with:
pattern: firmware-${{ inputs.keymap }}-*
path: .
merge-multiple: true
- name: Upload all firmwares
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v7
with:
name: firmware-${{ inputs.keymap }}
if-no-files-found: ignore

View file

@ -24,11 +24,12 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run tests
run: qmk pytest

34
.github/workflows/develop_docs.yml vendored Normal file
View file

@ -0,0 +1,34 @@
name: Generate Develop Docs
permissions:
contents: write
on:
push:
branches:
- develop
paths:
- 'builddefs/docsgen/**'
- 'tmk_core/**'
- 'quantum/**'
- 'platforms/**'
- 'docs/**'
- '.github/workflows/docs.yml'
jobs:
generate:
runs-on: ubuntu-latest
steps:
- name: Deploy Develop
if: ${{ github.repository == 'qmk/qmk_firmware' }}
uses: actions/github-script@v8
with:
github-token: ${{ secrets.QMK_BOT_TOKEN }}
script: |
const result = await github.rest.actions.createWorkflowDispatch({
owner: 'qmk',
repo: 'qmk_docs_devel',
workflow_id: 'develop.yml',
ref: 'main',
})

View file

@ -15,7 +15,7 @@ jobs:
if: github.repository == 'qmk/qmk_firmware'
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
fetch-depth: 0

View file

@ -30,14 +30,15 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
fetch-depth: 1
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Install nvm
run: |
apt-get update && apt-get install -y rsync doxygen
# install nvm
touch $HOME/.bashrc
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
@ -56,7 +57,7 @@ jobs:
- name: Deploy
if: ${{ github.event_name == 'push' && github.repository == 'qmk/qmk_firmware' }}
uses: JamesIves/github-pages-deploy-action@v4.7.4
uses: JamesIves/github-pages-deploy-action@v4.8.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages

View file

@ -21,7 +21,7 @@ jobs:
- riot
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
token: ${{ secrets.QMK_BOT_TOKEN }}
fetch-depth: 0

View file

@ -26,7 +26,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
fetch-depth: 0

View file

@ -19,7 +19,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
fetch-depth: 0
@ -47,7 +47,7 @@ jobs:
git config user.email 'hello@qmk.fm'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
uses: peter-evans/create-pull-request@v8
if: ${{ github.repository == 'qmk/qmk_firmware'}}
with:
token: ${{ secrets.QMK_BOT_TOKEN }}

View file

@ -18,7 +18,7 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
fetch-depth: 0
@ -31,7 +31,7 @@ jobs:
with:
use_rest_api: true
- name: Print info
- name: Print git info
run: |
git rev-parse --short HEAD
echo ${{ github.event.pull_request.base.sha }}
@ -57,7 +57,7 @@ jobs:
if [[ $KEYMAP_ONLY -gt 0 ]]; then
echo "linting ${KB}"
qmk lint --keyboard ${KB} && qmk info -l --keyboard ${KB}
qmk lint --strict --keyboard ${KB} && qmk info -l --keyboard ${KB}
exit_code=$(($exit_code + $?))
fi
done
@ -78,10 +78,37 @@ jobs:
fi
exit $exit_code
- name: Verify keyboard aliases
- name: Reset git repo
if: always()
shell: 'bash {0}'
run: |
git reset --hard
git clean -xfd
- name: Verify keyboard targets
if: always()
shell: 'bash {0}'
run: |
exit_code=0
for file in $(find keyboards/ -name rules.mk | grep -v /keymaps/ | grep -v /common/ | grep -v /lib/); do
dir=$(dirname $file)
$(find $dir -name keyboard.json -exec false {} +)
if [[ $? == 0 ]]; then
echo "$dir::Legacy target detected"
((++exit_code))
fi
done
if [[ $exit_code -gt 255 ]]; then
exit 255
fi
exit $exit_code
- name: Verify keyboard aliases
if: always()
shell: 'bash {0}'
run: |
qmk ci-validate-aliases

View file

@ -19,7 +19,10 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run qmk generators
run: |

View file

@ -19,7 +19,10 @@ jobs:
- name: Disable safe.directory check
run : git config --global --add safe.directory '*'
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run qmk generators
run: |
@ -34,7 +37,7 @@ jobs:
git config user.email 'hello@qmk.fm'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
uses: peter-evans/create-pull-request@v8
if: ${{ github.repository == 'qmk/qmk_firmware'}}
with:
token: ${{ secrets.QMK_BOT_TOKEN }}

View file

@ -26,10 +26,12 @@ jobs:
container: ghcr.io/qmk/qmk_cli
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
with:
submodules: recursive
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run tests
run: qmk test-c

2
.gitignore vendored
View file

@ -65,6 +65,8 @@ cmake-build-debug
CMakeLists.txt
*.pdf
*.zip
.env
.envrc
# Let these ones be user specific, since we have so many different configurations
*.code-workspace

View file

@ -19,18 +19,18 @@ endif
ifneq ($(QMK_USERSPACE),)
ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
KEYMAP_JSON_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_5)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
KEYMAP_JSON_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_4)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
KEYMAP_JSON_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_3)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
KEYMAP_JSON_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_2)
else ifneq ("$(wildcard $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.json)","")
KEYMAP_JSON := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)/keymap.json
KEYMAP_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
KEYMAP_JSON_PATH := $(QMK_USERSPACE)/$(MAIN_KEYMAP_PATH_1)
endif
endif

Some files were not shown because too many files have changed in this diff Show more