search

opensearch-project / opensearch-go

Go Client for OpenSearch
https://opensearch.org/docs/latest/clients/go/
Apache License 2.0
188 stars 96 forks source link

[BUG] Releases require a manual navigation to the released package URL #499

Open dblock opened 3 months ago

dblock commented 3 months ago

What is the bug?

When releasing 3.1.0 I ran into https://github.com/opensearch-project/opensearch-go/pull/498#issuecomment-2030597365.

The release was not appearing in https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3. A workaround was to navigate to https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3@v3.1.0 and hit "request".

I read in https://go.dev/doc/modules/publishing and per instructions tried running GOPROXY=proxy.golang.org go list -m github.com/opensearch-project/opensearch-go@v3.1.0 but that fails with not found: ... invalid version: go.mod has post-v3 module path "github.com/opensearch-project/opensearch-go/v3" at revision v3.1.0.

How can one reproduce the bug?

  1. Make a release per https://github.com/opensearch-project/opensearch-go/blob/main/RELEASING.md#releasing.
  2. Observe it not appearing on https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3

What is the expected behavior?

Release appears on https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3.

Solution

Either:

a) A release needs to ping the go service and tell it there's a new release. Likely a new workflow that runs every time a release is made. b) An update to RELEASING.md that says to go to the release URL