fix(developer): enforce presence of kps Info.Description field in info compilers #12204
Conversation
This file contains 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
…o compilers The Description field should be required for published keyboards and models, so this change means kmc-keyboard-info and kmc-model-info will report an error if it is missing. Relates-to: keymanapp/keyboards#3037 Relates-to: keymanapp/lexical-models#262 Fixes: #12202
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
mcdurdin
deleted the
fix/developer/12202-info-compilers-enforce-description-field
branch
|
Changes in this pull request will be available for download in Keyman version 18.0.91-alpha |
mcdurdin
added a commit
that referenced
this pull request
Dec 8, 2024
…ard-info Originally reported in #12202. Check was added in #12204, backported to 17.0.329 in #12207, but #12597 reports this for 17.0.331. So added test to verify that it is working as expected (it is). Note that this only applies when using the `--for-publishing` build flag in kmc, because it is checked in the kmc-keyboard-info stage. Guessing this is where the confusion arose. Consolidated tests which used a common pattern for kmc-keyboard-info calls. The remaining tests do stubs or calls into internal functions, so they cannot be easily deduped. Fixes: #12597
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.
The Description field should be required for published keyboards and models, so this change means kmc-keyboard-info and kmc-model-info will report an error if it is missing.
Relates-to: keymanapp/keyboards#3037
Relates-to: keymanapp/lexical-models#262
Fixes: #12202
@keymanapp-test-bot skip