Can a Go module be published in the same path as a previous non-module module?

Go module is an important feature introduced in Go language version 1.11. It can help developers better manage and rely on third-party libraries in projects. For the previous projects developed in non-module mode, PHP editor Banana tells everyone that modules and non-module modules can be published in the same path. The advantage of this is that it can easily and gradually migrate existing projects to the module mode, while also maintaining the usability and stability of the project. However, it should be noted that when publishing modules and non-module modules under the same path, you need to follow some rules and conventions to ensure the normal operation of the project.

Question content

I have a small library that has been hosted in a non-module repository, but I now want to convert it to a go module.

I successfully executed:

go mod init
go mod tidy

The

go.mod and go.sum files are created without errors, and the library still passes the test.

The previous version was v2.0.0, so I increased the version to v3.0.0 and added /v3 to go. mod at the end of the module name. From what I've seen online, this is what is needed. My go.mod file looks like this:

module tssgit.reyrey.com/teschste/go-utils/v3

go 1.19

require (
    github.com/lib/pq v1.10.9
    golang.org/x/text v0.9.0
)

I then published the library to our internal git server and thought I was ready.

When I try to add the library to a new go module project, I receive the following message:

Installing: tssgit.reyrey.com/teschste/go-utils/v3
Installing dependency: tssgit.reyrey.com/teschste/go-utils/v3
go: module tssgit.reyrey.com/teschste/go-utils@upgrade found (v2.0.0+incompatible), but does not contain package tssgit.reyrey.com/teschste/go-utils/v3
Failed to add dependencies: exit status 1

I found that if I published v3.0.0 to a new path (tssgit.reyrey.com/teschste/go-utils2) I was able to successfully add it to my new project, even if I increase the main project version again.

Am I missing something that would allow me to continue publishing on the same path, or is this just something you can't do?

Any help would be greatly appreciated!

Solution

Yes, this is supported. The version subdirectory is optional.

I found a situation that causes the error you are seeing. This happens when the master branch is not updated (still points to tag v2.0.0) and the new tag v3.0.0 is not pushed to the server. Please double check to make sure the remote repository is updated.

If the remote repository has been updated but still not working properly, you can narrow down the problem like this:

1. Run with the -x option go get:

   $ go get -x tssgit.reyrey.com/teschste/go-utils/v3

2. cd Go to the directory shown in the output. The directory path is like this:

   /home/username/go/pkg/mod/cache/vcs/96f42aa32430149c99ad6625ceafc5b59e047b9e11d6a03f687d59845b53b2d5

3. In this directory, run git ls-remote -q origin and check the output. The example below is when it doesn't work on my machine. You can see that head and v2.0.0 both point to the same commit id, and there is no v3.0.0.

   $ git ls-remote -q origin
   5ac4c172806e80461086ea9feb485cec0b6a27f0    HEAD
   5ac4c172806e80461086ea9feb485cec0b6a27f0    refs/heads/main
   bbdc583c0b83489db1a30fa6ca8559ffa295a74d    refs/heads/other-branch
   5ac4c172806e80461086ea9feb485cec0b6a27f0    refs/tags/v2.0.0

   The above is the detailed content of Can a Go module be published in the same path as a previous non-module module?. For more information, please follow other related articles on the PHP Chinese website!