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

opentelemetry-instrumentation-falcon: expand supported version to v4 #3086

Merged
merged 10 commits into from
Dec 23, 2024

Conversation

stevapple
Copy link
Contributor

@stevapple stevapple commented Dec 10, 2024

Description

Falcon v4 has a mostly identical interface to v3, and is proved to be fully compatible with opentelemetry-instrumentation-falcon. Loose the version check to <5.0.0 to avoid false DependencyConflict alarm, and fix the tests for v3.1.2+.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Local testing shows that the package is compatible with Falcon v4.

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

Copy link
Member

@emdneto emdneto left a comment

Choose a reason for hiding this comment

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

Thanks.
you need to update pyproject.toml file with the new version, runtox -e generate and commit the changes. In that case, it's necessary to add tests to CI -- Add test-requirements.txt with the respective package version and include a new entry in tox.ini file

I'm writing a guideline in CONTRIBUTING.md to make this more clear.
EDIT: #3090 Some guidance here

@stevapple stevapple requested a review from a team as a code owner December 11, 2024 05:48
@stevapple stevapple changed the title Expand Falcon supported version to v4 opentelemetry-instrumentation-falcon: expand supported version to v4 Dec 11, 2024
@stevapple
Copy link
Contributor Author

@emdneto Thank you for the guidance! Please check out if it's now fix. I regerated the docs and tests according to your new PR.

@xrmx
Copy link
Contributor

xrmx commented Dec 11, 2024

@stevapple Would be nice if you'll test things before opening PRs, thanks.

@stevapple
Copy link
Contributor Author

@stevapple Would be nice if you'll test things before opening PRs, thanks.

It took some time as I failed to set up tox for the project on Windows, and it turns out that the only breaking changes happened in v3.1.2 instead of v4. I've add test presets for both of them.

Falcon v4 has a mostly identical interface to v3, and is proved to be fully compatible with `opentelemetry-instrumentation-falcon`. Loose the version check to `<5.0.0` to avoid false `DependencyConflict` alarm.
@stevapple stevapple force-pushed the patch-2 branch 2 times, most recently from 81d2a66 to 22cf021 Compare December 11, 2024 14:39
@stevapple stevapple requested a review from emdneto December 12, 2024 08:25
@emdneto emdneto mentioned this pull request Dec 23, 2024
13 tasks
Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>
Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>
Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>
Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>
@xrmx xrmx enabled auto-merge (squash) December 23, 2024 17:29
@xrmx xrmx merged commit 2176e3e into open-telemetry:main Dec 23, 2024
594 checks passed
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.

3 participants