system-upgrade-controller icon indicating copy to clipboard operation
system-upgrade-controller copied to clipboard

Consider tagging submodule "pkg/apis"?

Open Rick-xuy opened this issue 2 years ago • 1 comments

I found that package github.com/rancher/system-upgrade-controller/pkg/apis/upgrade.cattle.io/v1 is placed in submodule github.com/rancher/system-upgrade-controller/pkg/apis instead of root module.
However, it seems that submodule github.com/rancher/system-upgrade-controller/pkg/apis is not tagged. According to Go Modules wiki, submodule should be tagged like relative-path-to-root/vX.X.X. At now, when trying to import package github.com/rancher/system-upgrade-controller/pkg/apis/upgrade.cattle.io/v1, downstream would depends on pseudo-version of module github.com/rancher/system-upgrade-controller/pkg/apis.

github.com/rancher/system-upgrade-controller/pkg/apis v0.0.0-20210727200656-10b094e30007

I think it is not very readable and difficult to upgrade. This is not conductive to version control either. So, I propose whether it is possible to tag submodule properly. For example, pkg/apis/v0.0.1, pkg/apis/v0.10.0etc, so that other project can use tag to import this module in go.mod.

Rick-xuy avatar Feb 17 '23 07:02 Rick-xuy

As per https://github.com/rancher/system-upgrade-controller/pull/102#issuecomment-678731594 we are not currently planning on tagging the submodule. We can discuss doing so at some point, but I want to coordinate that with other projects that currently import it before doing so. The pseudo-version is usable for the time being.

brandond avatar Aug 24 '23 23:08 brandond