Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ed3721648a |
||
|
|
9e8199c411 |
||
|
|
7bea08cb12 |
||
|
|
e52319b751 |
||
|
|
1ba0300da7 |
||
|
|
3ac6f603a8 |
||
|
|
63a3fc3591 |
||
|
|
45ccd2e935 |
||
|
|
b01ed7d34f |
||
|
|
a7f524f264 |
||
|
|
8a6c081c4a |
||
|
|
b6d46cdc47 |
||
|
|
6729379041 |
||
|
|
38815db760 |
||
|
|
863b308519 |
||
|
|
127c664647 |
||
|
|
7d66c11f37 |
||
|
|
e391793f73 |
||
|
|
70c36c6c97 |
||
|
|
56a2e332e1 |
||
|
|
e31384babf |
||
|
|
a0b15d08bc |
||
|
|
3d591a2000 |
||
|
|
1e683923e1 |
||
|
|
3194862502 |
||
|
|
8c035c2116 |
||
|
|
91a9f9e492 |
||
|
|
ddeaa26fef |
||
|
|
f3a16ef21d |
||
|
|
99b5b9ab7f |
||
|
|
6a5610a8be |
||
|
|
acbeec29da |
||
|
|
7e35cdda8a |
||
|
|
dba60e2e65 |
||
|
|
c68281b353 |
||
|
|
84d44e6188 |
||
|
|
54e8fad959 |
||
|
|
2c847b0350 |
||
|
|
e1c869b8da |
||
|
|
9e0118172f |
||
|
|
4f9582da26 |
||
|
|
2e68ddc826 |
||
|
|
c1fedab457 |
||
|
|
2929448605 |
||
|
|
b39661de96 |
||
|
|
ff75bce86a |
||
|
|
0881e0867b |
||
|
|
e6e66a9f2e |
||
|
|
e2d19eda57 |
||
|
|
73a6496516 |
||
|
|
c8f6e6a936 |
||
|
|
a86322e4a7 |
||
|
|
505e5c7033 |
||
|
|
107812ceef |
||
|
|
de8f05b4c3 |
||
|
|
08e5fcfdf4 |
||
|
|
1322922c42 |
||
|
|
16dde871d7 |
||
|
|
d39015a401 |
||
|
|
bf0b88c423 |
||
|
|
d4f04fe850 |
||
|
|
b315b707e6 | ||
|
|
e10429baae | ||
|
|
0e6b73c9ff |
||
|
|
d45b967cf2 | ||
|
|
e2bf515df4 |
||
|
|
2cac8b587f |
||
|
|
d383e93526 | ||
|
|
83b42ea9dc |
||
|
|
43bbb5e99a |
||
|
|
ee60542bd6 | ||
|
|
6ed61c65dd |
||
|
|
b5dfb2bd1e |
||
|
|
ee44cbdedb | ||
|
|
330a8597f8 |
||
|
|
9acd127cc1 | ||
|
|
9c2ca00074 |
||
|
|
9ab8e4cd5a | ||
|
|
594558ec7b |
||
|
|
5e1b1f5023 |
||
|
|
bbccd8f9cc | ||
|
|
cc567c917b |
||
|
|
1a954e8da5 |
||
|
|
c7e17538ee |
||
|
|
b321789d7b |
||
|
|
4015c40ba4 |
||
|
|
53de903fb8 |
||
|
|
fd65390496 |
||
|
|
28a11ff6f7 |
||
|
|
1a7f544e0d |
||
|
|
3e0b22af68 |
||
|
|
7edb4d2ed8 | ||
|
|
81cc69c2dd |
||
|
|
93274019a9 | ||
|
|
0fde9c9cac |
||
|
|
b708a43730 | ||
|
|
5bb7476400 |
||
|
|
8eebc613cf |
||
|
|
a2adc92066 | ||
|
|
6242c09f7d |
||
|
|
224ea2eb18 | ||
|
|
eb5703d12e |
||
|
|
921c0039f4 | ||
|
|
bb2ca21647 |
||
|
|
1a4af3adf9 |
||
|
|
99b1dc84da |
||
|
|
98504424b1 |
||
|
|
8ec3de0f92 |
||
|
|
c68e4dec10 |
||
|
|
1ddcf57382 |
||
|
|
e06d79e9c6 | ||
|
|
019cba746d | ||
|
|
28eeb92f8e |
||
|
|
efc5d63383 |
||
|
|
2af9aac61c | ||
|
|
fb6d7762b9 | ||
|
|
6e35013bc2 |
||
|
|
cf05c7d1e4 | ||
|
|
4b393a1ff5 | ||
|
|
01952bf39a |
||
|
|
1a991ffd24 |
||
|
|
01d81b9550 |
||
|
|
a00177d172 | ||
|
|
b905c246b5 | ||
|
|
547d75145b |
||
|
|
f1ec600fac | ||
|
|
c67e4c2cae |
||
|
|
5ba424ca17 |
||
|
|
e7012f4d9e | ||
|
|
8c93a33cd3 |
||
|
|
6aade0ecdc | ||
|
|
ce43c98b65 | ||
|
|
acd7ad37e6 |
||
|
|
cbd55b7890 |
||
|
|
dadbec4d46 | ||
|
|
cb3149b7f2 |
||
|
|
64c84e64c7 | ||
|
|
a05306d153 | ||
|
|
946d651f57 | ||
|
|
7ea7930b8c | ||
|
|
e91938088a | ||
|
|
81df543086 |
||
|
|
4f21beb715 |
||
|
|
18051f1723 | ||
|
|
3eb8d3bea3 | ||
|
|
f4068dbfb0 |
||
|
|
08405df150 |
||
|
|
3c751f217a | ||
|
|
9f1a7380ab |
||
|
|
7dca4e8bda |
||
|
|
0aae222ab6 |
||
|
|
475cbd24cf | ||
|
|
81a3249e2c | ||
|
|
0550830909 |
||
|
|
8f86f9794e | ||
|
|
e7d861aea7 | ||
|
|
02cf2b56fd |
||
|
|
5d26dcefa0 | ||
|
|
c7ed9038d7 |
||
|
|
7a69c714b4 | ||
|
|
074c49ee1c | ||
|
|
466e0856f5 |
||
|
|
60cf3c22f7 | ||
|
|
05355bc49d |
||
|
|
74ac4120db | ||
|
|
9a77ad69e6 | ||
|
|
187119ed7f | ||
|
|
fecfc0f7da |
||
|
|
36fd2437b0 |
||
|
|
bbd6e8ab34 |
||
|
|
24bc4aef03 | ||
|
|
532fb2f960 | ||
|
|
6f93a86e6e |
||
|
|
0a4c1caf20 |
||
|
|
883465d9fb |
||
|
|
115bf771a8 |
||
|
|
a4b112b1ef |
||
|
|
d1b0397d2f | ||
|
|
46231df62d |
||
|
|
b6310b5a15 |
||
|
|
d34cade5ab |
||
|
|
cf58a8733d |
||
|
|
3320e98ccf |
||
|
|
319da7bfdb |
||
|
|
4a4e4aa083 |
||
|
|
74b0f054c1 |
||
|
|
6eee1940e8 | ||
|
|
626cf94653 | ||
|
|
494a691f4c | ||
|
|
f8d677af88 |
||
|
|
461a1afe57 | ||
|
|
d4fb67fd5b | ||
|
|
3cd8dd6b25 | ||
|
|
a4d10e9f64 |
||
|
|
286947b6fa |
||
|
|
f12902eb16 |
||
|
|
0351b598f9 | ||
|
|
c113250c4e | ||
|
|
633479ced5 |
||
|
|
a91de72246 |
||
|
|
50edd425f7 | ||
|
|
514175848e | ||
|
|
7caef16edd | ||
|
|
ff8db0449e | ||
|
|
7772f47f04 | ||
|
|
ab61d9cb51 | ||
|
|
649bbdeaba | ||
|
|
eda39f4356 |
||
|
|
c3ba5de928 | ||
|
|
592ee1b57f | ||
|
|
db9b295aa7 |
||
|
|
3934a7f3c8 |
||
|
|
ed2de21603 |
||
|
|
04978d490a |
||
|
|
7186a63172 |
||
|
|
ff1900190c |
||
|
|
2818085d3f |
||
|
|
d17671cd23 |
||
|
|
8f22831f01 |
||
|
|
6c96bb5a5a |
||
|
|
177ff71d0c |
||
|
|
c1b428bb4e |
||
|
|
0828fc4b6f |
||
|
|
1e8de37aa0 |
||
|
|
9cd3080e22 |
||
|
|
ceefde5ec8 |
||
|
|
3a29cdbd7d |
||
|
|
2d5cb23503 |
||
|
|
6aa85699a5 |
||
|
|
330d195f9a |
||
|
|
4b1b83f42f |
||
|
|
f749dedb0d | ||
|
|
e01313e7d0 | ||
|
|
4bd5c033c3 |
||
|
|
5830b1b5e3 | ||
|
|
bcc546aa3f |
||
|
|
19527e8399 |
||
|
|
d8ce8cd204 |
||
|
|
248d7c1d6d |
||
|
|
9455c6adec |
||
|
|
6619ea4441 |
1303 changed files with 38030 additions and 18160 deletions
430
.github/copilot-instructions.md
vendored
Normal file
430
.github/copilot-instructions.md
vendored
Normal 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.
|
||||
2
.github/workflows/api.yml
vendored
2
.github/workflows/api.yml
vendored
|
|
@ -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
|
||||
|
|
|
|||
2
.github/workflows/auto_approve.yml
vendored
2
.github/workflows/auto_approve.yml
vendored
|
|
@ -4,7 +4,7 @@ permissions: {}
|
|||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "*/5 * * * *"
|
||||
- cron: "*/30 * * * *"
|
||||
|
||||
jobs:
|
||||
automatic_approve:
|
||||
|
|
|
|||
2
.github/workflows/auto_tag.yml
vendored
2
.github/workflows/auto_tag.yml
vendored
|
|
@ -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
289
.github/workflows/bootstrap_testing.yml
vendored
Normal 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
|
||||
|
||||
14
.github/workflows/ci_build_major_branch.yml
vendored
14
.github/workflows/ci_build_major_branch.yml
vendored
|
|
@ -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: .
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
3
.github/workflows/cli.yml
vendored
3
.github/workflows/cli.yml
vendored
|
|
@ -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
34
.github/workflows/develop_docs.yml
vendored
Normal 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',
|
||||
})
|
||||
2
.github/workflows/develop_update.yml
vendored
2
.github/workflows/develop_update.yml
vendored
|
|
@ -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
|
||||
|
|
|
|||
9
.github/workflows/docs.yml
vendored
9
.github/workflows/docs.yml
vendored
|
|
@ -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
|
||||
|
|
|
|||
2
.github/workflows/feature_branch_update.yml
vendored
2
.github/workflows/feature_branch_update.yml
vendored
|
|
@ -21,7 +21,7 @@ jobs:
|
|||
- riot
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/checkout@v6
|
||||
with:
|
||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
||||
fetch-depth: 0
|
||||
|
|
|
|||
2
.github/workflows/format.yml
vendored
2
.github/workflows/format.yml
vendored
|
|
@ -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
|
||||
|
||||
|
|
|
|||
4
.github/workflows/format_push.yml
vendored
4
.github/workflows/format_push.yml
vendored
|
|
@ -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 }}
|
||||
|
|
|
|||
35
.github/workflows/lint.yml
vendored
35
.github/workflows/lint.yml
vendored
|
|
@ -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
|
||||
|
|
|
|||
5
.github/workflows/regen.yml
vendored
5
.github/workflows/regen.yml
vendored
|
|
@ -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: |
|
||||
|
|
|
|||
7
.github/workflows/regen_push.yml
vendored
7
.github/workflows/regen_push.yml
vendored
|
|
@ -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 }}
|
||||
|
|
|
|||
4
.github/workflows/unit_test.yml
vendored
4
.github/workflows/unit_test.yml
vendored
|
|
@ -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
2
.gitignore
vendored
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
Loading…
Reference in a new issue