x/pkgsite: completely retracted sub-modules still appear in the directories view (github.com/creachadair/ffs/cmd, github.com/creachadair/ffs/storage)

[creachadair]

When I originally created the github.com/creachadair/ffs repository, I set up multiple modules. This turned out to be a mistake (for the usual reasons), and I later split one module (ffs/cmd) out into its own repository, and combined the other (ffs/storage) back into the main module.

And that mostly worked, except that the pkgsite page for the root module still shows cmd and storage as separate modules. And cmd no longer exists in that repo at all, while storage is versioned with the root.

I realize in retrospect that I should have done things differently, but now I don't see a practical way for me to fix this with retractions. Is it possible to have those two modules suppressed from pkgsite?

The part I am not sure about is, can this be done without breaking the resolution of the import path github.com/creachadair/ffs/storage, which previously pointed to a separate module but now points to a subpackage of the root module? I hope the answer is yes, because pkgsite does show the correct documentation for the current code therein—it just also shows a "module" indicator in the UI. (If this is impractical, however, I can live with it).

The other import path, github.com/creachadair/ffs/cmd, no longer exists at all, so I hope it may be easy to suppress.

[hyangah]

Most pkgsite removal requests are handled by just hiding the information from the pkg.go.dev (permanently). The modules will keep being served from proxy which will interfere with go get.

You need the modules removed from the proxy.golang.org to use packages under storage, and packages under storage (but from the root module) should be visible from pkg.go.dev.

In your case, I think you need to retract the module (github.com/creachadiar/ffs/storage) properly.
https://go.dev/ref/mod#go-mod-file-retract

See #50514 for the similar case.

[gabyhelp]

Related Issues

• x/pkgsite: Request removal of obsolete package paths #47849 (closed)
• x/pkgsite: Request to Remove Modules and Restore Package on pkg.go.dev #71532 (closed)
• x/pkgsite: package removal request for ask.systems/daemon/spawn #56114 (closed)
• x/pkgsite: package removal request for github.com/OI4/oi4-oec-service-go #69876 (closed)
• x/pkgsite: Remove 2 modules #41439 (closed)
• x/pkgsite: package removal request for https://pkg.go.dev/github.com/idrunk/dce-go/util #71524 (closed)
• x/pkgsite: package removal request for https://pkg.go.dev/github.com/amandlaus/gocrypt #68611 (closed)
• x/pkgsite: package removal request for github.com/google/gnostic/cmd/* #50514 (closed)
• x/pkgsite: hide/remove github.com/oaswrap/spec/{adapters,module/specui} #78535 (closed)
• x/pkgsite: remove some repositories #43478 (closed)

_{(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)}

[creachadair]

You need the modules removed from the proxy.golang.org to use packages under storage, and packages under storage (but from the root module) should be visible from pkg.go.dev.

In your case, I think you need to retract the module (github.com/creachadiar/ffs/storage) properly. https://go.dev/ref/mod#go-mod-file-retract

Thank you for the advice, I was able to publish retractions for both of those modules, at least to the point where they display the "Retracted" banner on pkgsite. Is there any additional step that we'd need to also de-list them from pkgsite, or will that happen naturally now that all versions are retracted?

I suppose arguably that doesn't matter, but the docs on pkgsite for the root module still show the retracted cmd submodule, and still label the retracted storage submodule as "[module]". The latter is cosmetic and probably doesn't matter, but the former would be nice to remove if we can.

[hyangah]

Thanks a lot @creachadair for retracting the modules!
Yes, the retracted banner or showing the completely retracted modules/packages in the list is clearly a bug in the pkgsite codebase. We are looking into it.

One minor complication was that the cmd and storage modules that carried the retract info don't have any go packages in them, so pkgsite's pkg skipped processing that beyond updating its retracted version info so the v0.18.0 version of modules even didn't show up. But I think that's totally a pkgsite's bug.

[creachadair]

One minor complication was that the cmd and storage modules that carried the retract info don't have any go packages in them, so pkgsite's pkg skipped processing that beyond updating its retracted version info so the v0.18.0 version of modules even didn't show up. But I think that's totally a pkgsite's bug.

That is probably at least partially my fault. The way I did the retraction was to push a branch rewound to the commit where (specifically: after) I moved those modules, and adding additional commits to restore a go.mod with retractions. And in fact at that commit there are no packages there. It would be annoying but not impossible for me to roll back a bit further and update the retractions, though I'd rather avoid that if I can.