Skip to content

chore(core): Remove km_core_keyboard_attrs.folder_path 🎼#15471

Merged
ermshiperete merged 2 commits intoepic/web-corefrom
chore/core/deprecation
Feb 13, 2026
Merged

chore(core): Remove km_core_keyboard_attrs.folder_path 🎼#15471
ermshiperete merged 2 commits intoepic/web-corefrom
chore/core/deprecation

Conversation

@ermshiperete
Copy link
Copy Markdown
Contributor

PR #12769 removed km_core_keyboard_load that allowed loading a keyboard from a path. Instead we now pass a BLOB to core to load a keyboard. With the function gone there is no longer a need to have a field with the path.

Follow-up-of: #12497
Related-to: #12769
Test-bot: skip

@keymanapp-test-bot
Copy link
Copy Markdown

keymanapp-test-bot Bot commented Jan 19, 2026

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

  • macOS
    • Keyman for macOS - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for macOS (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")

@github-actions github-actions Bot added the chore label Jan 19, 2026
@keymanapp-test-bot keymanapp-test-bot Bot changed the title chore(core): Remove km_core_keyboard_attrs.folder_path chore(core): Remove km_core_keyboard_attrs.folder_path 🎼 Jan 19, 2026
@keymanapp-test-bot keymanapp-test-bot Bot added this to the A19S21 milestone Jan 19, 2026
@ermshiperete ermshiperete force-pushed the chore/core/deprecation branch from 20cd352 to 812b93e Compare January 20, 2026 14:17
PR #12769 removed `km_core_keyboard_load` that allowed loading a keyboard
from a path. Instead we now pass a BLOB to core to load a keyboard.
With the function gone there is no longer a need to have a field with the
path.

Follow-up-of: #12497
Related-to: #12769
Test-bot: skip
@ermshiperete ermshiperete force-pushed the chore/core/deprecation branch from 812b93e to 0422b3f Compare January 20, 2026 14:17
@ermshiperete ermshiperete marked this pull request as ready for review January 20, 2026 16:26
@keyman-server keyman-server modified the milestones: A19S21, A19S22 Jan 31, 2026
Copy link
Copy Markdown
Member

@mcdurdin mcdurdin left a comment

Choose a reason for hiding this comment

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

I am not sure about this change. We have not published an API stability policy but perhaps we need to. For example GNOME's policy.

Removal of fields is not backwardly compatible; the question in my mind is if we need to maintain backward compatibility for Core because it is normally tightly linked to a release. (If we have other consumers of the Keyman Core API, then this will become a more serious question.)

If we do publish this, it is a Keyman Core API change that needs to be listed in our 19.0 changes wiki

@mcdurdin
Copy link
Copy Markdown
Member

After discussion, decided to go ahead and update this API along with corresponding release note.

@ermshiperete ermshiperete merged commit 22c06a0 into epic/web-core Feb 13, 2026
22 of 23 checks passed
@ermshiperete ermshiperete deleted the chore/core/deprecation branch February 13, 2026 10:27
@github-project-automation github-project-automation Bot moved this from Todo to Done in Keyman Feb 13, 2026
ermshiperete added a commit that referenced this pull request Feb 13, 2026
Turns out we have a document for the API changes, in addition to the
release notes. That document got overlooked so far. This change now
updates that doc with the API changes that happened since v17.

Build-bot: skip
Test-bot: skip
Follow-up-of: #15471
Follow-up-of: #12769
@ermshiperete
Copy link
Copy Markdown
Contributor Author

Oops - there's also core/docs/api/changes.md that documents API changes. #15590 updates that.

ermshiperete added a commit that referenced this pull request Feb 16, 2026
chore(core): update API `changes.md` document 🎼

Turns out we have a document for the API changes, in addition to the release notes. That document got overlooked so far. This change now updates that doc with the API changes that happened since v17.

Follow-up-of: #15471
Follow-up-of: #12769
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants