Documentation on pkg.go.dev not available due to licence file and tags

[rogchap]

The recent change to the license file has caused the documentation to be removed from https://pkg.go.dev site:

https://pkg.go.dev/github.com/newrelic/go-agent/v3/newrelic?tab=overview

[purple4reina]

@rogchap Thanks for bringing this to our attention. We are working to address it.

[v3n]

I think what's causing the problem is the repository layout. When using the major directory model, everything must exist in that directory, including licenses/readmes.

golang/go#41333 (comment)

I'd like to request the removal of the V3 directory, moving everything up to root and instead use the layout that Google uses for their Github library:

• https://github.com/google/go-github
• https://github.com/google/go-github/blob/master/go.mod

The major directory model has been causing pain for me, since the repository is unsearchable via Github without finding both v2 and v3 code.

[tydavis]

I might have been a little overzealous, but the license file was copied to both the v3 and v3/newrelic subdirectories to guarantee coverage.

[tydavis]

#254 has been merged. When released, it should fix this issue.

[RichVanderwal]

We're targeting a Monday afternoon (January 11, 2021) release.

[tydavis]

https://pkg.go.dev/github.com/newrelic/go-agent/v3/newrelic -- Issue resolved as of 2021-01-11 3:40pm Pacific time.

[RichVanderwal]

The integrations' documentation still isn't showing up, most likely due to tags not being updated. I'm reopening this issue until we can see documentation for the tools in v3/integrations.

[tydavis]

@RichVanderwal Likely a tagging problem, yes. Once the tag for the 3.X series is pushed/scanned/updated, it should trigger an update.

You could also try running:

curl https://sum.golang.org/lookup/github.com/newrelic/go-agent/v3/[email protected]

Update: Response from the server:

not found: github.com/newrelic/go-agent/v3/[email protected]: invalid version: unknown revision v3/integrations/v3.12.0

[RichVanderwal]

Still working on this. Testing the two updated integration packages nrawssdk-v2 and nrgrpc, and also with one un-updated integration, nrzap.