zephyr
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

blog: Merge duplicate "Getting The Changes" sections in Zephyr 4.1 post (#3142)

This commit is contained in:
carrefinho 2025-12-13 23:38:58 -05:00 committed by GitHub
parent c0990410da
commit 90b3ad2c9e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
docs/blog/2025-12-09-zephyr-4-1.md
View File

@ -28,31 +28,38 @@ For all users, except those willing to accept periodic breaks they need to track
## Getting The Changes
Since the changes are merged to ZMK `main`, you'll need to be using that version of ZMK to use/tests these changes.
### User Config Repositories Using GitHub Actions
### Local Development
Existing user repositories that have `revision: main` in their `west.yml` will receive the changes automatically when rebuilding.
To get the update, first pull the latest ZMK `main`:
Any user repositories created on or after `2025-07-03` are currently pinned to the most recent ZMK release. You will need to change over to `main` to get these changes immediately, or wait for `v0.4` and upgrade your version then.
See the recent [blog post on pinning ZMK versions](./2025-06-20-pinned-zmk.md) for more information.
```
git checkout main && git pull main
```
Likewise, if you are currently on `main` but do not wish to upgrade yet, please pin your ZMK version to `v0.3` by following the instructions in said blog post.
Once you have the updated ZMK code, update the referenced modules:
### VS Code & Docker (Dev Container)
```
west update
```
If you build locally using VS Code & Docker then:
To be sure you've got all the updated Python packages needed to build ZMK, use west again:
- Pull the latest ZMK `main` with `git pull` for your ZMK checkout
- Reload the project
- If you are prompted to rebuild the remote container, click `Rebuild`
- Otherwise, press `F1` and run `Remote Containers: Rebuild Container`
- Once the container has rebuilt and reloaded, run `west update` to pull the updated Zephyr version and its dependencies.
```
west packages pip --install
```
Once the container has rebuilt, VS Code will be running the 4.1 Docker image.
### GitHub Actions Builds
### Local Host Development
To test these changes, you need to verify that the `west.yml` for your build is using a `revision: main` property. Once this is verified, simply run a new build and the updated Zephyr version will be used.
The following steps will get you building ZMK locally against Zephyr 4.1:
- Run the updated [toolchain installation](/docs/development/local-toolchain/setup) steps, and once completed, remove the previously installed SDK version (optional, existing SDK should still work)
- Install the latest version of `west` by running `pip3 install --upgrade west` in a virtual environment, or add the `--user` flag if `west` is installed globally: `pip3 install --user --upgrade west`.
- Pull the latest ZMK `main` with `git pull` for your ZMK checkout
- Run `west update` to pull the updated Zephyr version and its dependencies
- Run `west packages pip --install` to update required Python packages
From there, you should be ready to build as normal!
## Board Revisions
@ -87,40 +94,6 @@ As part of this change, ZMK is now using board/shield revisions, rather than dup
The boards above are those which have changed in ZMK's tree, with the addition of the very popular XIAO series. For other boards in Zephyr's tree, please refer to the Zephyr documentation or source files directly.
## Getting The Changes
### User Config Repositories Using GitHub Actions
Existing user repositories which are currently running ZMK's `main` branch will receive the changes automatically when rebuilding.
Any user repositories created on or after `2025-07-03` are currently pinned to the most recent ZMK release. You will need to change over to `main` to get these changes immediately, or wait for `v0.4` and upgrade your version then.
See the recent [blog post on pinning ZMK versions](./2025-06-20-pinned-zmk.md) for more information.
Likewise, if you are currently on `main` but do not wish to upgrade yet, please pin your ZMK version to `v0.3` by following the instructions in said blog post.
### VS Code & Docker (Dev Container)
If you build locally using VS Code & Docker then:
- Pull the latest ZMK `main` with `git pull` for your ZMK checkout
- Reload the project
- If you are prompted to rebuild the remote container, click `Rebuild`
- Otherwise, press `F1` and run `Remote Containers: Rebuild Container`
- Once the container has rebuilt and reloaded, run `west update` to pull the updated Zephyr version and its dependencies.
Once the container has rebuilt, VS Code will be running the 4.1 Docker image.
### Local Host Development
The following steps will get you building ZMK locally against Zephyr 4.1:
- Run the updated [toolchain installation](/docs/development/local-toolchain/setup) steps, and once completed, remove the previously installed SDK version (optional, existing SDK should still work)
- Install the latest version of `west` by running `pip3 install --upgrade west` in a virtual environment, or add the `--user` flag if `west` is installed globally: `pip3 install --user --upgrade west`.
- Pull the latest ZMK `main` with `git pull` for your ZMK checkout
- Run `west update` to pull the updated Zephyr version and its dependencies
From there, you should be ready to build as normal!
## Moving To HWMv2
The move to HWMv2 has already been completed for all boards in ZMK's `main` branch. For out-of-tree boards, those need to be converted using either an automated script provided by the Zephyr project, or manually.