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

general: replace gopkg.in/DataDog/dd-trace-go.v1 with github.com/DataDog/dd-trace-go/v2 #2300

Merged
merged 10 commits into from
Oct 30, 2023

Conversation

darccio
Copy link
Member

@darccio darccio commented Oct 26, 2023

What does this PR do?

This PR changes the canonical import URL, setting it as github.com/DataDog/dd-trace-go/v2.

This is the first step towards the new v2 major version.

It's a big PR but it contains the result of search-and-replace operations for the old import URL. We considered to do smaller PRs for contribs, but it was simpler to do the changes at once, specially to test the CI too.

Tests are green ✅ , although it involved creating specific branches in system-tests and appsec-go-test-app. These branches will remain unmerged until the v2 release.

Documentation files (README.md, contrrib/README.md and MIGRATING.md) will be updated in following PRs.

Motivation

gopkg.in isn't needed anymore, and it's not well maintained.

Reviewer's Checklist

  • Changed code has unit tests for its functionality at or near 100% coverage.
  • 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.

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 force-pushed the dario.castane/AIT-3705/remove-gopkgin branch from 66e426e to fe165bd Compare October 27, 2023 09:02
@pr-commenter
Copy link

pr-commenter bot commented Oct 27, 2023

Benchmarks

Benchmark execution time: 2023-10-30 12:09:35

Comparing candidate commit 30541af in PR branch dario.castane/AIT-3705/remove-gopkgin with baseline commit b72ad1b in branch v2-dev.

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

@darccio darccio force-pushed the dario.castane/AIT-3705/remove-gopkgin branch from 2d0f8d4 to 6fe30bf Compare October 27, 2023 10:20
@darccio darccio force-pushed the dario.castane/AIT-3705/remove-gopkgin branch from 91549ac to 37dad66 Compare October 27, 2023 12:18
@@ -151,6 +151,7 @@ jobs:
- run: docker run --platform=linux/arm64 -v $PWD:$PWD -w $PWD -eCGO_ENABLED=${{ matrix.cgo_enabled }} -eDD_APPSEC_ENABLED=${{ matrix.appsec_enabled }} -eDD_APPSEC_WAF_TIMEOUT=$DD_APPSEC_WAF_TIMEOUT golang go test -v -tags appsec $TO_TEST

smoke-tests:
uses: DataDog/appsec-go-test-app/.github/workflows/smoke-tests.yml@main
# TODO(darccio): change to main branch on v2 release
uses: DataDog/appsec-go-test-app/.github/workflows/[email protected]/AIT-3705/dd-trace-go.v2
Copy link
Member Author

Choose a reason for hiding this comment

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

This branch will be open until v2 release.

@@ -93,7 +93,8 @@ jobs:
uses: actions/checkout@v3
with:
repository: 'DataDog/system-tests'
ref: ${{ inputs.ref }}
# TODO(darccio): remove ref on v2 release
ref: 5af583da64c7458daf3fdf5e5538b90cdc4d9154
Copy link
Member Author

Choose a reason for hiding this comment

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

This branch will be open until v2 release.

MIGRATING.md Outdated
Copy link
Member Author

Choose a reason for hiding this comment

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

This migration guide will be reviewed before the v2 release. It will be replaced with a new version for migrating from 1.x to 2.x.

README.md Outdated
Copy link
Member Author

Choose a reason for hiding this comment

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

More changes will be done in this README during the next weeks.

@darccio darccio marked this pull request as ready for review October 27, 2023 13:18
@darccio darccio requested a review from a team October 27, 2023 13:18
@darccio darccio requested review from a team as code owners October 27, 2023 13:18
@darccio darccio removed request for a team October 30, 2023 11:10
@darccio darccio merged commit 89c2869 into v2-dev Oct 30, 2023
340 checks passed
@darccio darccio deleted the dario.castane/AIT-3705/remove-gopkgin branch October 30, 2023 14:29
@felixge
Copy link
Member

felixge commented Oct 31, 2023

This PR changes the canonical import URL, setting it as github.com/DataDog/dd-trace-go-v2.

Is this (from the PR description) accurate? It seems like the import path is actually changed to: github.com/DataDog/dd-trace-go/v2 ?

@darccio
Copy link
Member Author

darccio commented Oct 31, 2023

This PR changes the canonical import URL, setting it as github.com/DataDog/dd-trace-go-v2.

Is this (from the PR description) accurate? It seems like the import path is actually changed to: github.com/DataDog/dd-trace-go/v2 ?

You are right, it was a typo in the PR's description.

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