chore(developer): add --for-publishing to kmc 🎺 #9717
Merged
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
The new --for-publishing flag allows us to enforce additional requirements for keyboards and lexical models that are to be published to the keymanapp repositories. This flag will always be switched on in the repository builds. This flag overrides the 'skipMetadata' option which is a project-level option. There is a bit of a delicate balance of requirements here: 1. We want to be able to automatically verify keyboards and package licenses if they are in the repository. 2. We do not want to force license checks on privately built keyboards and models. 3. We want to provide pathways for users to check locally before submitting to the repository. 4. If possible, we want to be able to build the .keyboard_info and .model_info files locally, but this should be up to the user for local builds. For now, the only additional check that this flag provides is to verify that the license is MIT, which was an unchecked requirement for the repositories in the past. Future checks can be added for file layout, additional required metadata files. Anticipate adding this as a tool to Keyman Developer IDE -- a 'pre-publish' check -- in the future.
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
keymanapp-test-bot
bot
changed the title
1 task
jahorton
approved these changes
Oct 10, 2023
3 tasks
Base automatically changed from
chore/update-kmp-compiler-xml2js-dependency
to
epic/package-metadata
October 11, 2023 00:19
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 new
--for-publishingflag allows us to enforce additional requirements for keyboards and lexical models that are to be published to the keymanapp repositories. This flag will always be switched on in the repository builds. This flag overrides theskipMetadataoption which is a project-level option.There is a bit of a delicate balance of requirements here:
For now, the only additional check that this flag provides is to verify that the license is MIT, which was an unchecked requirement for the repositories in the past.
Future checks can be added for file layout, additional required metadata files.
Anticipate adding this as a tool to Keyman Developer IDE -- a 'pre-publish' check -- in the future.
@keymanapp-test-bot skip