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(linux): Replace deprecated pkg_resources module with packaging.version #10860

Merged
merged 4 commits into from
Mar 20, 2024

Conversation

ermshiperete
Copy link
Contributor

Fixes #10850.

User Testing

Preparations

  • The tests should be run on these Linux platforms:

    • GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11
    • GROUP_JAMMY: Ubuntu 22.04 Jammy with Gnome Shell and X11 or Wayland
    • GROUP_NOBLE: Ubuntu 24.04 Noble with Gnome Shell and X11 or Wayland
  • Install build artifacts of this PR

  • Reboot

Tests

TEST_NO_WARNING:

  • run km-package-install --version
  • verify that the version is output, but no warning

@keymanapp-test-bot keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Feb 27, 2024
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Feb 27, 2024

User Test Results

Test specification and instructions

  • ✅ GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11

    1 tests PASSED
    • TEST_NO_WARNING (PASSED): Tested with the attached PR build on Ubuntu 20.04 Focal Linux OS (VM) and here is my observation: 1. Run km-package-install --version on the terminal and verified that it is showing the version as output without showing any warning message. (notes)
  • ✅ GROUP_JAMMY: Ubuntu 22.04 Jammy with Gnome Shell and X11 or Wayland

    1 tests PASSED
    • TEST_NO_WARNING (PASSED): Tested with the attached PR build (17.0.277-beta (package version 17..277-1~PR-10860-2445.1+jammy1) on Ubuntu 22.004 Jammy Linux OS (X11) (Virtual Box) and here is my observation: 1. It is showing the version number without any warning message after running the above command. (notes)
  • ✅ GROUP_NOBLE: Ubuntu 24.04 Noble with Gnome Shell and X11 or Wayland

    1 tests PASSED
    • TEST_NO_WARNING (PASSED): ):

Test Artifacts

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

It isn't enough to have the package as build dependency, we also have to
list is in the binary package or in the `install_requires` list in
`setup.py`. This change also adds other missing python modules to
`install_requires` so that things work correctly if building/installing
from source.
@ermshiperete ermshiperete force-pushed the fix/linux/10850_deprecation branch from a5cb464 to f899627 Compare February 29, 2024 17:50
@bharanidharanj
Copy link

Test Results

GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11

  • TEST_NO_WARNING (PASSED): Tested with the attached PR build on Ubuntu 20.04 Focal Linux OS (VM) and here is my observation: 1. Run km-package-install --version on the terminal and verified that it is showing the version as output without showing any warning message.

@bharanidharanj
Copy link

Test Results

GROUP_NOBLE: Ubuntu 24.04 Noble with Gnome Shell and X11 or Wayland

  • TEST_NO_WARNING (FAILED): Tested with the attached PR build on Ubuntu 24.04 Noble Linux OS (wayland) (VM) and here is my observation: 1. Run km-package-install --version on the terminal and verified that it is showing the version with a warning message. Seems to be an issue.

@mcdurdin mcdurdin modified the milestones: B17S2, B17S3 Mar 3, 2024
@bharanidharanj
Copy link

Test Results

GROUP_JAMMY: Ubuntu 22.04 Jammy with Gnome Shell and X11 or Wayland

  • TEST_NO_WARNING (PASSED): Tested with the attached PR build (17.0.277-beta (package version 17..277-1~PR-10860-2445.1+jammy1) on Ubuntu 22.004 Jammy Linux OS (X11) (Virtual Box) and here is my observation: 1. It is showing the version number without any warning message after running the above command.

@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Mar 4, 2024
@darcywong00 darcywong00 modified the milestones: B17S3, B17S4 Mar 16, 2024
…aces

Previous commit missed a few places where `pkg_resources` module was
used.
@ermshiperete
Copy link
Contributor Author

ermshiperete commented Mar 20, 2024

GROUP_NOBLE:

  • TEST_NO_WARNING (PASSED):

@ermshiperete ermshiperete merged commit d7d5c80 into beta Mar 20, 2024
7 checks passed
@ermshiperete ermshiperete deleted the fix/linux/10850_deprecation branch March 20, 2024 14:47
@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 17.0.291-beta

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.

bug(linux): Deprecation warning when running km-package-install
5 participants