Skip to content

Add GitHub workflow to update README versions of Karabiner#386

Open
overhacked wants to merge 1 commit into
houmain:mainfrom
overhacked:overhacked/readme-update-with-karabiner-version
Open

Add GitHub workflow to update README versions of Karabiner#386
overhacked wants to merge 1 commit into
houmain:mainfrom
overhacked:overhacked/readme-update-with-karabiner-version

Conversation

@overhacked

Copy link
Copy Markdown

Update README with required versions of Karabiner-DriverKit-VirtualHIDDevice and Karabiner-Elements. Add workflow to keep versions in README up-to-date with vendored source in src/lib/Karabiner-DriverKit-VirtualHIDDevice.

Uses version from the version.json provided by vendor upstream and a locally-maintained elements-version.json, indicating which version of Karabiner Elements bundles the right version of VirtualHIDDevice. elements-version.json would need to be updated any time the VirtualHIDDevice dependency is upgraded, since upstream doesn't sync the version numbers.

Update README with required versions of
Karabiner-DriverKit-VirtualHIDDevice and Karabiner-Elements.

Signed-off-by: Ross Williams <ross@ross-williams.net>
@overhacked

overhacked commented Jul 17, 2026

Copy link
Copy Markdown
Author

You can see the workflow running in my repo: https://github.com/overhacked/keymapper/actions/workflows/push.yml

One run with the README changed and one where it skips because the version numbers didn't change.

And an example PR that the workflow opened to update the README: overhacked#1. It's also possible to have the workflow directly commit the README changes to main, but I wanted to make the default more polite than that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant