Skip to content

Commit c724ad2

Browse files
committed
Merge branch 'petejohanson-feat/pointers-with-input-processors' into fingerpunch
* petejohanson-feat/pointers-with-input-processors: (186 commits) docs: Add initial pointer docs. feat: Add input split support. feat(mouse): Add mouse move and scroll support feat(boards): Update for mikoto board definition (zmkfirmware#1946) refactor(Kconfig): Extracted designer defaults out into new files (zmkfirmware#2537) chore(main): release 0.1.0 (zmkfirmware#2657) docs: Create a Hardware Integration index page (zmkfirmware#2634) docs: Mention combos in reset behaviors (zmkfirmware#2677) fix(boards): Disable uart serial node in Xiao BLE by default (zmkfirmware#2672) chore(deps): bump the prod-other-minor-patch group across 1 directory with 2 updates feat(boards): Add glove80 nexus node for extension GPIO. (zmkfirmware#2594) docs: Move defines to the end in layer behaviors (zmkfirmware#2639) docs: Update new-shield.mdx (zmkfirmware#2664) docs(ci): Netlify ignore command to check branch (zmkfirmware#2659) chore(deps): bump cross-spawn from 7.0.3 to 7.0.6 in /docs feat(ci): Add release-please automation with VERSION (zmkfirmware#2622) docs: Remove dangling 0 in sticky keys docs fix: include a header file for RC macros (zmkfirmware#2649) feat(drivers): Support init high/low in 595 driver docs: touchups on the soft off information for improved clarity. (zmkfirmware#2647) ...
2 parents 48d62da + f9705f5 commit c724ad2

File tree

616 files changed

+22783
-7283
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

616 files changed

+22783
-7283
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"mounts": [
1010
"type=volume,source=zmk-root-user,target=/root",
1111
"type=volume,source=zmk-config,target=/workspaces/zmk-config",
12+
"type=volume,source=zmk-modules,target=/workspaces/zmk-modules",
1213
"type=volume,source=zmk-zephyr,target=${containerWorkspaceFolder}/zephyr",
1314
"type=volume,source=zmk-zephyr-modules,target=${containerWorkspaceFolder}/modules",
1415
"type=volume,source=zmk-zephyr-tools,target=${containerWorkspaceFolder}/tools"

.github/dependabot.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,50 @@ updates:
88
directory: "/docs"
99
schedule:
1010
interval: "daily"
11+
groups:
12+
docusaurus-major:
13+
applies-to: "version-updates"
14+
dependency-type: "production"
15+
patterns:
16+
- "@docusaurus/*"
17+
update-types:
18+
- "major"
19+
docusaurus-minor-patch:
20+
applies-to: "version-updates"
21+
dependency-type: "production"
22+
patterns:
23+
- "@docusaurus/*"
24+
update-types:
25+
- "minor"
26+
- "patch"
27+
tree-sitter:
28+
applies-to: "version-updates"
29+
dependency-type: "production"
30+
patterns:
31+
- "tree-sitter-devicetree"
32+
- "web-tree-sitter"
33+
prod-other-major:
34+
applies-to: "version-updates"
35+
dependency-type: "production"
36+
exclude-patterns:
37+
- "@docusaurus/*"
38+
- "tree-sitter-devicetree"
39+
- "web-tree-sitter"
40+
update-types:
41+
- "major"
42+
prod-other-minor-patch:
43+
applies-to: "version-updates"
44+
dependency-type: "production"
45+
exclude-patterns:
46+
- "@docusaurus/*"
47+
- "tree-sitter-devicetree"
48+
- "web-tree-sitter"
49+
update-types:
50+
- "minor"
51+
- "patch"
52+
development:
53+
applies-to: "version-updates"
54+
dependency-type: "development"
55+
update-types:
56+
- "minor"
57+
- "patch"

.github/pull_request_template.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,8 @@
1-
<!-- If you're adding a board/shield please fill out this check-list, otherwise you can delete it -->
1+
<!-- Note: ZMK is generally not accepting PRs for new keyboards. New generic controller PRs *may* still be accepted, please discuss on the Discord server first. -->
22

3-
## Board/Shield Check-list
3+
## PR check-list
44

5-
- [ ] This board/shield is tested working on real hardware
6-
- [ ] Definitions follow the general style of other shields/boards upstream ([Reference](https://zmk.dev/docs/development/new-shield))
7-
- [ ] `.zmk.yml` metadata file added
5+
- [ ] Branch has a [clean commit history](https://zmk.dev/docs/development/contributing/pull-requests#clean-commit-history)
6+
- [ ] Additional tests are included, if changing behaviors/core code that is testable.
87
- [ ] Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
9-
- [ ] General consistent formatting of DeviceTree files
10-
- [ ] Keymaps do not use deprecated key defines (Check using the [upgrader tool](https://zmk.dev/docs/codes/keymap-upgrader))
11-
- [ ] `&pro_micro` used in favor of `&pro_micro_d/a` if applicable
12-
- [ ] If split, no name added for the right/peripheral half
13-
- [ ] Kconfig.defconfig file correctly wraps _all_ configuration in conditional on the shield symbol
14-
- [ ] `.conf` file has optional extra features commented out
15-
- [ ] Keyboard/PCB is part of a shipped group buy or is generally available in stock to purchase (OSH/personal projects without general availability should create a zmk-config repo instead)
8+
- [ ] [Pre-commit](https://zmk.dev/docs/development/local-toolchain/pre-commit) used to check formatting of files, commit messages, etc.

.github/workflows/build-user-config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ on:
2626

2727
jobs:
2828
matrix:
29-
runs-on: ubuntu-latest
29+
runs-on: ubuntu-22.04
3030
name: Fetch Build Keyboards
3131
outputs:
3232
build_matrix: ${{ env.build_matrix }}

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ jobs:
430430
uses: actions/checkout@v4
431431
with:
432432
persist-credentials: false
433-
- uses: tj-actions/changed-files@v44
433+
- uses: tj-actions/changed-files@v45
434434
id: changed-files
435435
with:
436436
json: true

.github/workflows/release-please.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
- "v*.*-branch"
6+
7+
permissions:
8+
contents: write
9+
pull-requests: write
10+
11+
name: release-please
12+
13+
jobs:
14+
release-please:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: googleapis/release-please-action@v4
18+
id: release
19+
with:
20+
token: ${{ secrets.ZMK_RELEASE_PLEASE_TOKEN }}
21+
target-branch: ${{ github.ref_name }}
22+
- uses: actions/checkout@v4
23+
if: ${{ steps.release.outputs.release_created }}
24+
- name: create major, minor branch
25+
if: ${{ steps.release.outputs.release_created && steps.release.outputs.patch == '0' }}
26+
run: |
27+
git remote add gh-token-branch "https://x-access-token:${{ secrets.ZMK_RELEASE_PLEASE_TOKEN }}@github.com/${{ github.repository }}.git"
28+
git checkout -b v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}-branch
29+
git push gh-token-branch v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}-branch
30+
- name: tag major and minor versions
31+
if: ${{ steps.release.outputs.release_created }}
32+
run: |
33+
git config user.name github-actions[bot]
34+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
35+
git remote add gh-token "https://x-access-token:${{ secrets.ZMK_RELEASE_PLEASE_TOKEN }}@github.com/${{ github.repository }}.git"
36+
git tag -d v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
37+
git tag -a v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} -m "Release v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}"
38+
git push --force gh-token v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}

.gitlint

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# Edit this file as you like.
2+
#
3+
# All these sections are optional. Each section with the exception of [general] represents
4+
# one rule and each key in it is an option for that specific rule.
5+
#
6+
# Rules and sections can be referenced by their full name or by id. For example
7+
# section "[body-max-line-length]" could also be written as "[B1]". Full section names are
8+
# used in here for clarity.
9+
#
10+
[general]
11+
# Ignore certain rules, this example uses both full name and id
12+
# ignore=title-trailing-punctuation, T3
13+
14+
# verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this
15+
# verbosity = 2
16+
17+
# By default gitlint will ignore merge, revert, fixup, fixup=amend, and squash commits.
18+
# ignore-merge-commits=true
19+
# ignore-revert-commits=true
20+
# ignore-fixup-commits=true
21+
# ignore-fixup-amend-commits=true
22+
# ignore-squash-commits=true
23+
24+
# Ignore any data sent to gitlint via stdin
25+
# ignore-stdin=true
26+
27+
# Fetch additional meta-data from the local repository when manually passing a
28+
# commit message to gitlint via stdin or --commit-msg. Disabled by default.
29+
# staged=true
30+
31+
# Hard fail when the target commit range is empty. Note that gitlint will
32+
# already fail by default on invalid commit ranges. This option is specifically
33+
# to tell gitlint to fail on *valid but empty* commit ranges.
34+
# Disabled by default.
35+
# fail-without-commits=true
36+
37+
# Whether to use Python `search` instead of `match` semantics in rules that use
38+
# regexes. Context: https://github.com/jorisroovers/gitlint/issues/254
39+
# Disabled by default, but will be enabled by default in the future.
40+
# regex-style-search=true
41+
42+
# Enable debug mode (prints more output). Disabled by default.
43+
# debug=true
44+
45+
# Enable community contributed rules
46+
# See http://jorisroovers.github.io/gitlint/contrib_rules for details
47+
contrib=contrib-title-conventional-commits,CT1,contrib-disallow-cleanup-commits,CC2
48+
49+
# Set the extra-path where gitlint will search for user defined rules
50+
# See http://jorisroovers.github.io/gitlint/user_defined_rules for details
51+
# extra-path=examples/
52+
53+
[title-max-length]
54+
line-length=80
55+
56+
# Conversely, you can also enforce minimal length of a title with the
57+
# "title-min-length" rule:
58+
# [title-min-length]
59+
# min-length=5
60+
61+
# [title-must-not-contain-word]
62+
# Comma-separated list of words that should not occur in the title. Matching is case
63+
# insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING"
64+
# will not cause a violation, but "WIP: my title" will.
65+
# words=wip
66+
67+
# [title-match-regex]
68+
# python-style regex that the commit-msg title must match
69+
# Note that the regex can contradict with other rules if not used correctly
70+
# (e.g. title-must-not-contain-word).
71+
# regex=^US[0-9]*
72+
73+
# [body-max-line-length]
74+
# line-length=72
75+
76+
# [body-min-length]
77+
# min-length=5
78+
79+
# [body-is-missing]
80+
# Whether to ignore this rule on merge commits (which typically only have a title)
81+
# default = True
82+
# ignore-merge-commits=false
83+
84+
# [body-changed-file-mention]
85+
# List of files that need to be explicitly mentioned in the body when they are changed
86+
# This is useful for when developers often erroneously edit certain files or git submodules.
87+
# By specifying this rule, developers can only change the file when they explicitly reference
88+
# it in the commit message.
89+
# files=gitlint-core/gitlint/rules.py,README.md
90+
91+
# [body-match-regex]
92+
# python-style regex that the commit-msg body must match.
93+
# E.g. body must end in My-Commit-Tag: foo
94+
# regex=My-Commit-Tag: foo$
95+
96+
# [author-valid-email]
97+
# python-style regex that the commit author email address must match.
98+
# For example, use the following regex if you only want to allow email addresses from foo.com
99+
# regex=[^@][email protected]
100+
101+
# [ignore-by-title]
102+
# Ignore certain rules for commits of which the title matches a regex
103+
# E.g. Match commit titles that start with "Release"
104+
# regex=^Release(.*)
105+
106+
# Ignore certain rules, you can reference them by their id or by their full name
107+
# Use 'all' to ignore all rules
108+
# ignore=T1,body-min-length
109+
110+
# [ignore-by-body]
111+
# Ignore certain rules for commits of which the body has a line that matches a regex
112+
# E.g. Match bodies that have a line that that contain "release"
113+
# regex=(.*)release(.*)
114+
#
115+
# Ignore certain rules, you can reference them by their id or by their full name
116+
# Use 'all' to ignore all rules
117+
# ignore=T1,body-min-length
118+
119+
# [ignore-body-lines]
120+
# Ignore certain lines in a commit body that match a regex.
121+
# E.g. Ignore all lines that start with 'Co-Authored-By'
122+
# regex=^Co-Authored-By
123+
124+
# [ignore-by-author-name]
125+
# Ignore certain rules for commits of which the author name matches a regex
126+
# E.g. Match commits made by dependabot
127+
# regex=(.*)dependabot(.*)
128+
#
129+
# Ignore certain rules, you can reference them by their id or by their full name
130+
# Use 'all' to ignore all rules
131+
# ignore=T1,body-min-length
132+
133+
# This is a contrib rule - a community contributed rule. These are disabled by default.
134+
# You need to explicitly enable them one-by-one by adding them to the "contrib" option
135+
# under [general] section above.
136+
# [contrib-title-conventional-commits]
137+
# Specify allowed commit types. For details see: https://www.conventionalcommits.org/
138+
# types = bugfix,user-story,epic

.pre-commit-config.yaml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,31 @@ repos:
44
rev: v1.5.1
55
hooks:
66
- id: remove-tabs
7-
exclude: "vendor-prefixes\\.txt$"
8-
- repo: https://github.com/pocc/pre-commit-hooks
9-
rev: v1.3.5
7+
exclude: "vendor-prefixes\\.txt$|.git/COMMIT_EDITMSG"
8+
- repo: https://github.com/pre-commit/mirrors-clang-format
9+
rev: v18.1.8
1010
hooks:
1111
- id: clang-format
12+
types_or: [c++, c]
1213
args:
1314
- -i
1415
- repo: https://github.com/pre-commit/mirrors-prettier
1516
rev: v2.7.1
1617
hooks:
1718
- id: prettier
19+
exclude: |
20+
(?x)^(
21+
.git/COMMIT_EDITMSG|
22+
CHANGELOG.md|
23+
.release-please-manifest.json
24+
)$
1825
# Workaround for https://github.com/pre-commit/mirrors-prettier/issues/29
1926
additional_dependencies:
2027
28+
- repo: https://github.com/jorisroovers/gitlint
29+
rev: v0.19.1
30+
hooks:
31+
- id: gitlint
2132
- repo: https://github.com/pre-commit/pre-commit-hooks
2233
rev: v4.4.0
2334
hooks:

.release-please-manifest.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{".":"0.1.0"}

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Changelog
2+
3+
## 0.1.0 (2024-11-29)
4+
5+
6+
### Features
7+
8+
* **boards:** Add glove80 nexus node for extension GPIO. ([#2594](https://github.com/zmkfirmware/zmk/issues/2594)) ([fb359f5](https://github.com/zmkfirmware/zmk/commit/fb359f576619940164ca2e770b49b7b34f13428e))
9+
* **boards:** add nrf52833-nosd snippet ([63af296](https://github.com/zmkfirmware/zmk/commit/63af296b6efd8d677d584f372c9da9a4fedaa496))
10+
* **boards:** add nrf52840-nosd snippet ([4438b7b](https://github.com/zmkfirmware/zmk/commit/4438b7b835bfd1d4e89cdd955a4ab0fd2e2ae3bf))
11+
* **ci:** Add release-please automation with VERSION ([#2622](https://github.com/zmkfirmware/zmk/issues/2622)) ([ffa485c](https://github.com/zmkfirmware/zmk/commit/ffa485c11b48444acf3adf1e3c1cb3eed16fad94))
12+
* **drivers:** Support init high/low in 595 driver ([888c0d9](https://github.com/zmkfirmware/zmk/commit/888c0d966cd52f3ab5145992f61b14d6262c1951))
13+
14+
15+
### Bug Fixes
16+
17+
* **boards:** Disable uart serial node in Xiao BLE by default ([#2672](https://github.com/zmkfirmware/zmk/issues/2672)) ([230b860](https://github.com/zmkfirmware/zmk/commit/230b860f31063774c3bcc19afb6f92479462de24))
18+
* **boards:** Fix typo in BT75 metadata ([c9553c3](https://github.com/zmkfirmware/zmk/commit/c9553c31e3a3f39964391b006492995b5bb09c39))
19+
* Disable display feature for settings_reset ([b0f5789](https://github.com/zmkfirmware/zmk/commit/b0f5789b128f0f5599341398898fdb0e0407b2d3))
20+
* Fix inconsistent column offset property ([c7473fc](https://github.com/zmkfirmware/zmk/commit/c7473fc32557d2d384ab78d3acf51a05488f0214))
21+
* include a header file for RC macros ([#2649](https://github.com/zmkfirmware/zmk/issues/2649)) ([f8eff2f](https://github.com/zmkfirmware/zmk/commit/f8eff2fe34609c91211c25113f9d7db09f7d1689))
22+
* **studio:** Improved error message when keyboard is missing a physical layout. ([fed66a9](https://github.com/zmkfirmware/zmk/commit/fed66a92d000f4c8e0019d9ccdd167271324e8e9))

0 commit comments

Comments
 (0)