Skip to content

docs: address version management recommendation in the readme#874

Merged
KazuCocoa merged 8 commits intomasterfrom
set-max
May 30, 2023
Merged

docs: address version management recommendation in the readme#874
KazuCocoa merged 8 commits intomasterfrom
set-max

Conversation

@KazuCocoa
Copy link
Copy Markdown
Member

To prevent unexpected changes that could break this client's functionality.
Actually, the last break was by a patch version, but maybe it is reasonable to set the limit in the minor version for now.

@KazuCocoa KazuCocoa requested a review from mykola-mokhnach May 27, 2023 21:19
@mykola-mokhnach
Copy link
Copy Markdown
Contributor

is it chore or ci?

@KazuCocoa
Copy link
Copy Markdown
Member Author

Removed the ci change from this pr

@mykola-mokhnach
Copy link
Copy Markdown
Contributor

in java we just set the minimum version but don't limit the maximum one

in general, it has been already confirmed that selenium does not follow semver, so they may introduce breaking changes even in minor releases. For us this means we must either strictly limit the lib version and then manually release a new version of python client when a new selenium is releases and tested for the compatibility. Or just acknowledge that we are limited in resources and we cannot really cover the testing for each version change..

Based on the above statement my proposal would be to follow the same strategy we have in java:

  • the selenium version is set to a range where the minimum one is the recent tested/fixed one and the maximum one is the next major
  • we allow selenium client updates without further validations. If a compatibility issue happens we fix it, bump the miniumum supported version (if necessary) and release the new version of the python client
  • users can always lock/override selenium's version in their projects as a possible workaround

@KazuCocoa
Copy link
Copy Markdown
Member Author

Correct. Hm, actually maybe what we could as our best is to give users to keep local files in their eng. Let me modify this PR to add acknowledgment in the readme

@KazuCocoa KazuCocoa changed the title chore: set max selenium deps version docs: address version management recommendation in the readme May 29, 2023
@KazuCocoa
Copy link
Copy Markdown
Member Author

KazuCocoa commented May 29, 2023

Updated

@KazuCocoa KazuCocoa merged commit 2e7a6a3 into master May 30, 2023
@KazuCocoa KazuCocoa deleted the set-max branch May 30, 2023 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants