fix(internal): properly convert PEP 440 version to SemVer for RCM client [backport #4910 to 1.7] #4911
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ent (#4910) ## Description The fix for ensuring RCM used a SemVer compliant version string only took into account ddtrace versions that match `x.y.zrc2` or `x.y.zrc2.dev3+gf344hg`, but not `x.y.z.dev3+gf344hg`. This fix ensures that if we have a `.dev` without `rc` that we properly convert `.dev` -> `-dev` which will make it SemVer compliant. Since the tests rely heavily on the version of `ddtrace.__version__` writing a test is challenging. We should revisit this in the future so we can mock the version and parametrize the test to ensure all variations are tested. ## Checklist - [ ] Followed the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/contributing.html#Release-Note-Guidelines) when writing a release note. - [ ] Add additional sections for `feat` and `fix` pull requests. - [ ] [Library documentation](https://github.com/DataDog/dd-trace-py/tree/1.x/docs) and/or [Datadog's documentation site](https://github.com/DataDog/documentation/) is updated. Link to doc PR in description. ## Reviewer Checklist - [ ] Title is accurate. - [ ] Description motivates each change. - [ ] No unnecessary changes were introduced in this PR. - [ ] Avoid breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [ ] Tests provided or description of manual testing performed is included in the code or PR. - [ ] Release note has been added and follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/contributing.html#Release-Note-Guidelines), or else `changelog/no-changelog` label added. - [ ] All relevant GitHub issues are correctly linked. - [ ] Backports are identified and tagged with Mergifyio.
brettlangdon
added
the
changelog/no-changelog
ZStriker19
approved these changes
Jan 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Backport of #4910
The fix for ensuring RCM used a SemVer compliant version string only took into account ddtrace versions that match
x.y.zrc2orx.y.zrc2.dev3+gf344hg, but notx.y.z.dev3+gf344hg.This fix ensures that if we have a
.devwithoutrcthat we properly convert.dev->-devwhich will make it SemVer compliant.Since the tests rely heavily on the version of
ddtrace.__version__writing a test is challenging. We should revisit this in the future so we can mock the version and parametrize the test to ensure all variations are tested.Checklist
featandfixpull requests.site is updated. Link to doc PR in description.
Reviewer Checklist
changelog/no-changeloglabel added.