Proposal: Custom Go Module Domain for v2

[erka]

Currently, our Go SDK modules are published under GitHub paths:

github.com/open-feature/go-sdk/openfeature
github.com/open-feature/go-sdk-contrib/...

and for v2 we may have something like

github.com/open-feature/go-sdk/v2/openfeature
github.com/open-feature/go-sdk-contrib/v2/...

I’d like to propose exploring the possibility of using a custom Go module domain for v2, e.g.:

go.openfeature.dev/openfeature
go.openfeature.dev/contrib

This would make module imports cleaner and more consistent. Tools like modgen can generate the required static files for a custom domain, though it would require domain and hosting (which may involve a budget).

There are some pros and cons. Introducing a custom domain may add some overhead, especially for new modules or providers in contrib. However, hosting modules under go.openfeature.dev may allow us to collect access logs and convert them into meaningful insights, track downloads, and potentially build adoption trends with some additional analytics work.

As we look ahead to v2, this could be a great time to implement it if desirable. I’d love to hear your thoughts, and whether you’ve done something similar in the past.

[beeme1mr]

Hi @erka, I can handle updating the domain. I know the OTel team already does something similar. Maybe we can find a point of contact to see how they did it. I'm assuming they're using CNCF resources. I'm happy to support and I think it's a great idea but I don't have the cycles to drive this.

[erka]

OTel team maintains this repo for the Go vanity configuration. The deploy.sh script uses gcloud for deployment.

[erka]

I did some PoC and could do it with Github repo, an action, Github Pages and some DNS magic.

[sahidvelji]

This is a good idea. Relevant Go documentation: https://pkg.go.dev/cmd/go#hdr-Remote_import_paths
The documentation calls this a "custom import path", but it's often informally called "vanity URL".

[erka]

I did few iterations on this... I have updated my PoC and created two next branches in go-sdk and go-sdk-contrib repos.

I can get things working with this go.mod

module of/v2

go 1.25.0

require (
	go.openfeature.dev/v2 v2.0.0-20251218232127-d8ff296c1801
	go.openfeature.dev/v2/contrib/hooks/open-telemetry v0.3.7-0.20251219131714-ffb98ad0178d
)

But I think I may be following contrib into a pitfall, and the actual module name should be

go.openfeature.dev/contrib/hooks/open-telemetry/v2 v2.....

and all contrib packages should be v2 just to align with go sdk v2 and it's breaking changes.

[erka]

I think I am ready to transfer my repo to OpenFeature org.

[beeme1mr]

Hey @erka, are you around tomorrow? I can work with you to set this up.

[erka]

Hey @beeme1mr

That works for me.

[beeme1mr]

I wasn't able to connect with @erka yet but I did take a look at the repo he created. I think we could move it to the OpenFeature org or create a new one inspired by what has been done. We'll just need to wire up a subdomain for the GitHub page. I can take care of that as soon as the repo has been created.

[beeme1mr]

@erka donated his repo to the org. You can see it here. Thanks!

I've added the go.openfeature.dev subdomain and everything seems to be working. Once we've verified everything is working as expected, we can start updating our docs.