go-buildkite icon indicating copy to clipboard operation
go-buildkite copied to clipboard

Avoid stuttering in package path

Open JensRantil opened this issue 6 years ago • 4 comments

The package path is github.com/buildkite/go-buildkite/buildkite. That's buildkite three times. I propose at least removing one of them to github.com/buildkite/go-buildkite. Creating yet another Go package doesn't seem to be idiomatic Go from what I've seen elsewhere on Github.

JensRantil avatar Feb 03 '19 13:02 JensRantil

Agreed @JensRantil, as a golang dev it's always bothered me. It would be a major BC break is the thing that has prevented me from cleaning it up. Any suggestions?

lox avatar Feb 03 '19 23:02 lox

For non-golang folks, this is context: https://blog.golang.org/package-names

lox avatar Feb 03 '19 23:02 lox

It would be a major BC break is the thing that has prevented me from cleaning it up. Any suggestions?

If dependees are vendored they should not be impacted. The repo is versioned, which means that all dependees that are using versioning tools such as dep, go mod etc. should be either 1) safe or 2) in a spot where they easily could lock to current release.

The big question is if you'd like to be able to be backwards compatible with all dependees that are pointing to your master branch. I'd say that's considered really bad practise and, if so, they should start versioning their dependencies.

JensRantil avatar Feb 04 '19 14:02 JensRantil

Yeah, I think I probably agree @JensRantil. Perhaps we move things around and cut a 3.0.0 release.

lox avatar Feb 05 '19 02:02 lox