From 8f4282b982ca2843ef538978e7a298a85d4275c0 Mon Sep 17 00:00:00 2001 From: Nicolas Munnich Date: Wed, 7 Aug 2024 22:46:50 +0200 Subject: [PATCH] Add versioning --- .../hardware-metadata-files/hardware-metadata-files.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx b/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx index 55f7d3a5..9db6edeb 100644 --- a/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx +++ b/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx @@ -78,14 +78,12 @@ url: https://github.com/foostan/crkbd/ The `module` property has three children: - `url` pointing to the repository containing an appropriate module, if the type of the metadata demands it. This can be the same as `url`, and can be shared with other metadata files e.g. if multiple shields are defined in one module. -- `commit` specifying a commit from the `url` repository which should be used. This property **cannot** point to `HEAD`, though it can point to the commit that `HEAD` is set to at the time of writing. This is to help prevent sudden breaking or malicious changes to remote repositories from affecting the users and tools of `zmk-modules`. -- `outdated` is an optional child. If it is not present, it is assumed that the module is up-to-date with ZMK's `HEAD`. If it is present, then it points to the most recently working ZMK commit. - +- `version` is a list of assignments from ZMK versions to commits in the module. Note that a module's `HEAD` cannot be assigned to a ZMK version. ```yaml module: murl: https://github.com/infused-kim/kb_zmk_ps2_mouse_trackpoint_driver - commit: c43a0365183c58f74c285c585e0cbc1ea99f8a12 - outdated: thisisjustanexamplethemoduleisindate1234 + version: + - 1.0.0: c43a0365183c58f74c285c585e0cbc1ea99f8a12 ``` ## Item Types