x/pkgsite/cmd/pkgsite: (self-hosted) README.md not visible in untagged version, but visible in tagged version #64316
Labels
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
pkgsite
Milestone
This issue describes a problem in a self-hosted
pkgsite
environment.Setup
Our setup uses this commit as basis for a
pkgsite
frontend+worker, using Athens v0.12.1 as proxy (through the frontend's-proxy_url
commandline option) for our private Gitlab repositories. Our private Gitlab repositories are regularly fetched through the proxy, and the documentation is updated. This runs well. I can elaborate on the setup if that's needed.We noticed a discrepancy between non-tagged Go modules and tagged Go modules with regards to the
README
file. We useREADME.md
for easy reading within the Gitlab web interface.Problem description
In a repository containing a non-empty
README.md
with (multiple) Git tags (e.g.v1.1.4
), theREADME.md
is neatly shown inside the pkgsite frontend. However, in another repository that contains a non-emptyREADME.md
but does not have Git tags, theREADME.md
is not shown in the pkgsite frontend.Expected behaviour
Regardless of the presence of Git tags, a non-empty
README
should be visible within thepkgsite
frontend.Other information
The reported, most recent version in the untagged module is
v0.0.0-20231121130704-9ad3935cf734
. The reported, most recent version in the tagged module isv1.1.4
. Our Gitlab settings set thedevelop
branch as default branch. When cloning the repository, this defaults to pulling thedevelop
branch.In the untagged module, there exists a
master
branch with two commits, but the reported commit9ad3935cf734
is not present in that branch. Themaster
branch doesn't contain aREADME.md
. However, ifpkgsite
would use themaster
branch, I would have expected a rather empty directory structure on the documentation page. When looking at the untagged module on thepkgsite
frontend, it shows the directory structure currently present in the commit9ad3935cf734
.The size of
README.md
in the tagged repository is 641 bytes. The size ofREADME.md
in the untagged repository is 1134 bytes. TheMaxFileSize
ininternal/fetch/limit.go
is30 * megabyte
, so I'm not expecting theseREADME
s to hit the fetch limit. Our log files from the frontend and the worker (both on log levelinfo
) do not contain words likeexceeds
orfile size
.At this time, the pkgsite diff to
master@ee1eba0daf6405765d06de9643dfe6c620ed47a8
with regards to our version doesn't seem to indicate any patches that would describe and/or solve this problem.Referencing self-hosting tracking issue #39827 as well.
The text was updated successfully, but these errors were encountered: