Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(developer): support building .keyboard_info without source version 🎺 #9474

Conversation

mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Aug 16, 2023

Relates to #9351.

Adds support for building a .keyboard_info file without having source .keyboard_info file:

  • Constructs a default source .keyboard_info in memory
  • Hints if license is missing
  • If LICENSE.md is present, verifies it matches the MIT license text
  • Adds project option to turn on or off metadata generation. This will default to False for version 1.0 projects, and to True for version 2.0 projects. This means that the keyboard repository will need a PR to enable metadata generation for existing projects in the repository, but this is important to avoid breaking builds for existing projects that are not in the repository.
  • Turns on additional c8 coverage for kmc projects
  • Also fixes a file reference issue in kmpJson.options, where paths were stripped too early in the process.
  • Removes a now-irrelevant unit test for keyboard_info.

TODO:

  • markdown to html during the keyboard_info build (currently just copies straight)
  • font family considerations -- currently a generated name

@keymanapp-test-bot skip

Relates to #9351.

Adds support for building a .keyboard_info file without having source
.keyboard_info file:

* Constructs a default source .keyboard_info in memory
* Hints if license is missing
* If LICENSE.md is present, verifies it matches the MIT license text
* Adds project option to turn on or off metadata generation. This will
  default to False for version 1.0 projects, and to True for version 2.0
  projects. This means that the keyboard repository will need a PR to
  enable metadata generation for existing projects in the repository,
  but this is important to avoid breaking builds for existing projects
  that are not in the repository.
* Turns on additional c8 coverage for kmc projects
Also fixes a file reference issue in kmpJson.options, where paths were
stripped too early in the process.

Removes a now-irrelevant unit test for keyboard_info.

TODO: markdown to html during the keyboard_info build.
@mcdurdin mcdurdin marked this pull request as ready for review August 17, 2023 03:30
Copy link
Contributor

@darcywong00 darcywong00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcdurdin mcdurdin modified the milestones: A17S19, A17S20 Aug 18, 2023
Base automatically changed from chore/developer/keyboard-info-font-examples-cleanup to epic/package-metadata September 1, 2023 03:05
@mcdurdin mcdurdin merged commit 6e8cc16 into epic/package-metadata Sep 1, 2023
2 checks passed
@mcdurdin mcdurdin deleted the feat/developer/compile-without-source-keyboard-info branch September 1, 2023 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants