Repository navigation
docs: document ZMK-matched branch/revision strategy - #10
Merged
Merged
Conversation
Pin the Installation manifest example to ZMK v0.3.0 (both zmk and oskey) and explain that the oskey revision must match the zmk revision, since oskey compiles against ZMK internal APIs that change between versions. Add a "Versioning & branches" section to AGENTS.md describing the ZMK-mirrored branch strategy: main tracks ZMK main, v0.3.0 tracks the v0.3.0 release. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Targets the new
v0.3.0branch (snapshot ofmainat ZMK v0.3.0), establishing the ZMK-mirrored branch strategy in the docs.Why
oskey compiles against ZMK's internal behavior APIs, which change between ZMK versions. So each oskey branch must be built and tested against one specific ZMK revision, and users must pin matching revisions in their
west.yml. ZMK uses a rollingmainplus a branch per release; oskey now mirrors that:mainmain(unreleased — Zephyr 4.1, the future 0.4.0)v0.3.0v0.3.0(latest stable release, Zephyr 3.5)Changes
v0.3.0for bothzmkandoskey, and add a note (with a mapping table) making clear theoskeyrevision must match thezmkrevision, and that mismatches are unsupported.tests/manifest/west.ymlpin, thezmk-build-armimage/Zephyr correspondence, and the snapshot-on-release workflow.Docs-only; no behavior or test changes. The companion forward-line work (moving
mainonto ZMK 4.1) is tracked separately in #9.