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

fix(mac): limit short bundle version string to x.y.z format in info.plist #12233

Merged
merged 3 commits into from
Aug 26, 2024

Conversation

sgschantz
Copy link
Contributor

@sgschantz sgschantz commented Aug 20, 2024

In the info.plist for both the Keyman Engine and Input Method, remove the framing text so that CFBundleShortVersionString just contains the version string, x.y.z where x, y and z are numeric values.

Fixes: #12197
Fixes: #12130

For background, see discussion in PR #12156 which was addressing the side effect rather than the root cause.

User Testing

TEST_DOWNLOAD_KEYBOARD_VISIBLE_MONTEREY

  1. With a mac running macOS Monterey, select the Configuration... command from the Keyman menu
  2. In the Keyboards pane, click the Download Keyboard... button
  3. Confirm that the Download Keyboard dialog should appear as shown:
    image

TEST_DOWNLOAD_KEYBOARD_VISIBLE_OTHER_OS

  1. With a mac running a macOS version other than Monterey, select the Configuration... command from the Keyman menu
  2. In the Keyboards pane, click the Download Keyboard... button
  3. Confirm that the Download Keyboard dialog appears as shown above.

TEST_DOWNLOAD_AND_INSTALL_KEYBOARD

  1. Download and install a new keyboard after invoking the Configuration... command
  2. Confirm that the downloaded keyboard is installed successfully and can be used

in info.plist for both input method and engine, remove
the framing text so that it just contains the version
number triplet

Fixes: #12197
@sgschantz sgschantz added the mac/ label Aug 20, 2024
@sgschantz sgschantz added this to the A18S9 milestone Aug 20, 2024
@sgschantz sgschantz self-assigned this Aug 20, 2024
@keymanapp-test-bot keymanapp-test-bot bot added the user-test-missing User tests have not yet been defined for the PR label Aug 20, 2024
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Aug 20, 2024

User Test Results

Test specification and instructions

  • TEST_DOWNLOAD_KEYBOARD_VISIBLE_MONTEREY (PASSED) (notes)
  • TEST_DOWNLOAD_KEYBOARD_VISIBLE_OTHER_OS (PASSED) (notes)
  • TEST_DOWNLOAD_AND_INSTALL_KEYBOARD (PASSED) (notes)

@github-actions github-actions bot added the fix label Aug 20, 2024
@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-missing User tests have not yet been defined for the PR label Aug 20, 2024
@keymanapp-test-bot keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Aug 21, 2024
@sgschantz sgschantz marked this pull request as ready for review August 21, 2024 02:29
@sgschantz sgschantz requested a review from SabineSIL as a code owner August 21, 2024 02:29
@dinakaranr
Copy link

Test Results

I tested this issue with the attached "Keyman 18.0.94-alpha-test" build on the MacOS
Here is my observation.

  • TEST_DOWNLOAD_KEYBOARD_VISIBLE_MONTEREY (passed):
  1. Installed the MacOS Monterey version 12.0.1.
  2. Installed the "Keyman-18.0.94.dmg" file.
  3. Open the "Keyman Configuration" dialog by clicking the keyman icon.
  4. "Keyman: Download Keyboard" dialog by clicking the "Download Keyboard" button.
    Verified that the "Download keyboard" dialog appeared.
  • TEST_DOWNLOAD_KEYBOARD_VISIBLE_OTHER_OS (passed):
  1. Installed the "Keyman-18.0.94.dmg" file in the macOS sonoma 14 version.
  2. Open the "Keyman Configuration" dialog by clicking the keyman icon.
  3. "Keyman: Download Keyboard" dialog by clicking the "Download Keyboard" button.
    Verified that the "Download keyboard" dialog appeared.
  • TEST_DOWNLOAD_AND_INSTALL_KEYBOARD (passed):
  1. Open the "Keyman Configuration" dialog by clicking the keyman icon.
  2. "Keyman: Download Keyboard" dialog by clicking the "Download Keyboard" button.
  3. Downloaded and installed three languages(EuroLatin, Khmer Angkor, and Amharic) keyboard.
  4. Open the sticky notes and then type some text using the installed keyboards.
    It works great for me. Thank you.

@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Aug 23, 2024
@mcdurdin
Copy link
Member

This needs a cherry-pick to stable-17.0, I think.

@sgschantz sgschantz merged commit 5a00aab into master Aug 26, 2024
3 of 5 checks passed
@sgschantz sgschantz deleted the fix/mac/12197-invalid-version-string branch August 26, 2024 07:03
@sgschantz
Copy link
Contributor Author

This needs a cherry-pick to stable-17.0, I think.

The version string looks good in stable-17.0, so I think we're good to make this change for 18 only.

@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 18.0.98-alpha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
4 participants