v2 and go modules

[cludden]

Hey @Jeffail, I'm looking to embed benthos in another application, and running into issues with go modules. Out of curiosity, does the go.mod module directive need to be updated to include /v2 in accordance with https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher?

[Jeffail]

Hey @cludden,

Unfortunately with the V2 release I got stuck in an awkward position. I was already using modules to manage Benthos' own dependencies but when it came to the V2 release I was going to have to break compatibility with dep if I updated all the local import paths to be module compliant.

What I did instead was bump the major version but leave the go.mod unchanged, this is breaking the rules of Go modules, but in practice it actually works just fine with both dep and modules. With dep everything is the same, with modules you need to target the version tag as if Benthos didn't support modules at all.

To get the latest version of Benthos as a dependency (currently v2.8.6) you can run:

go get github.com/Jeffail/benthos@v2.8.6

That'll give you an ugly entry in your own go.mod as it judges Benthos as non-compliant, therefore using a pseudo version in the listing. Practically, however, it's all the same. Your import paths should still point to github.com/Jeffail/benthos.

My plan is that when modules are the Go tool default I'll do a major version bump that jumps straight into full modules compliance. At that point you'll be forced to use modules and use the github.com/Jeffail/benthos/v3.

[Jeffail]

The plugin example repo https://github.com/benthosdev/benthos-plugin-example shows you what that looks like.

[cludden]

Thanks for the quick reply!