Add versioning
This commit is contained in:
parent
f71e6c3cfa
commit
8f4282b982
1 changed files with 3 additions and 5 deletions
|
@ -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
|
||||
|
|
Loading…
Add table
Reference in a new issue