maint: Use go mod replace to pull gopacket dependency #183
Conversation
This file contains 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
MikeGoldsmith
added
the
type: maintenance
robbkidd
reviewed
Sep 15, 2023
| We maintain a fork of [gopacket/gopacket](https://github.com/gopacket/gopacket) as [honeycombio/gopacket](https://github.com/honeycombio/gopacket). | ||
| The agent is configured to use the official gopacket repo as part of it's main dependency chain and import paths. | ||
| The honeycomb fork is swaped in using a replace directive in go.mod. | ||
| This allows the fork to remain cleaner, easier to manage and makes it easier to provide upstream contributions. |
|
@MikeGoldsmith I've got some edits to DEVELOPING incoming for us to consider. |
- Appease markdown linter by turning the steps into bullets and most of the text and code blocks into paragraphs between them. - Fix some typos.
JamieDanielson
approved these changes
Sep 15, 2023
5 tasks
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.
Which problem is this PR solving?
Updates the agent's gopacket usage to default to gopacket/gopacket and then swap in our fork honeycombio/gopacket with a go mod replace directive. This allows the fork to remain cleaner because we won't need to rename the package namespace, easier to manage by referencing commit SHAs instead of our own release tags, and provides a place from which we can open upstream contributions.
Short description of the changes
How to verify that this has the expected result
Dependencies are cleaner with go.mod depending on official packages then swap in the fork that the agent can experiment with.