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

v2/contrib: update contrib naming policy #2536

Merged
merged 8 commits into from
Feb 23, 2024

Conversation

darccio
Copy link
Member

@darccio darccio commented Jan 31, 2024

What does this PR do?

Contrib naming policy has been changed. The previous one, if applied consistently, would lead to a bigger number of breaking changes.

The new one provides a better balance between our current existing contribs and having a consistent way to know from the import URL - combining it with the current version of the integrated package - what versions are supported in the integration.

The current contribs have been updated according to the new policy:

  • IBM/sarama.v1: renamed to IBM/sarama (only v1 is available)
  • olivere/elastic: renamed to olivere/elastic.v5 (the minimum supported version is v5,gopkg.in/olivere/elastic.v5)
  • segmentio/kafka.go.v0: renamed to segmentio/kafka-go (only v0 available, suffix not needed).
  • valyala/fasthttp.v1: renamed to valyala/fasthttp (only v1 is available).

The rest of integrations don’t need any change, as:

  • their integrated packages have only a v0 version
  • or they are compatible with v0 and any other major version
  • or they are already in the minimum supported major version
  • or their v0 was not published as a module
  • or they manage their package in a way that any lower major version has a version suffix but the current one not (like github.com/twitch/twirp).

Test methodology: downgrade the integrated packages to their highest v0 version and run go test -v ./.... Code must compile and tests must pass.

Motivation

Fix #544

Reviewer's Checklist

  • Changed code has unit tests for its functionality at or near 100% coverage.
  • System-Tests covering this feature have been added and enabled with the va.b.c-dev version tag.
  • There is a benchmark for any new code, or changes to existing code.
  • If this interacts with the agent in a new way, a system test has been added.
  • Add an appropriate team label so this PR gets put in the right place for the release notes.
  • Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild.

For Datadog employees:

  • If this PR touches code that handles credentials of any kind, such as Datadog API keys, I've requested a review from @DataDog/security-design-and-guidance.
  • This PR doesn't touch any of that.

Unsure? Have a question? Request a review!

@darccio darccio requested a review from a team as a code owner January 31, 2024 17:13
@darccio darccio requested a review from a team January 31, 2024 17:13
@pr-commenter
Copy link

pr-commenter bot commented Jan 31, 2024

Benchmarks

Benchmark execution time: 2024-02-23 14:38:10

Comparing candidate commit 2b19a23 in PR branch dario.castane/AIT-8732/contrib-naming-policy with baseline commit 0206562 in branch v2-dev.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 39 metrics, 2 unstable metrics.

Copy link
Contributor

@rarguelloF rarguelloF left a comment

Choose a reason for hiding this comment

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

The new naming policy LGTM!

@darccio darccio requested a review from a team as a code owner February 23, 2024 11:54
@darccio darccio merged commit 07211ad into v2-dev Feb 23, 2024
336 checks passed
@darccio darccio deleted the dario.castane/AIT-8732/contrib-naming-policy branch February 23, 2024 15:30
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