mirrors/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-09-13 06:17:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat: allow any README for .profile (#8798)

Browse source 
closes #1624

Co-authored-by: Maxim Slipenko <maks1ms@altlinux.org>
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8798
Reviewed-by: Otto <otto@codeberg.org>
Co-authored-by: Maxim Slipenko <maks1ms@noreply.codeberg.org>
Co-committed-by: Maxim Slipenko <maks1ms@noreply.codeberg.org>
This commit is contained in:
Maxim Slipenko 2025-09-01 13:58:00 +02:00 • committed by Otto
commit ed3b70cbb9
7 changed files with 102 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

12
routers/web/org/home.go
View file

@ -5,6 +5,8 @@ package org
import (
"fmt"
gotemplate "html/template"
"io"
"net/http"
"path"
"strings"
@ -180,8 +182,10 @@ func prepareOrgProfileReadme(ctx *context.Context, profileGitRepo *git.Repositor
} else {
defer rc.Close()
if markupType := markup.Type(profileReadme.Name()); markupType != "" {
if profileContent, err := markdown.RenderReader(&markup.RenderContext{
Ctx: ctx,
Type: markupType,
GitRepo: profileGitRepo,
Links: markup.Links{
// Pass repo link to markdown render for the full link of media elements.
@ -195,5 +199,13 @@ func prepareOrgProfileReadme(ctx *context.Context, profileGitRepo *git.Repositor
} else {
ctx.Data["ProfileReadme"] = profileContent
}
} else {
content, err := io.ReadAll(rc)
if err != nil {
log.Error("Read readme content failed: %v", err)
}
ctx.Data["ProfileReadme"] = gotemplate.HTMLEscapeString(util.UnsafeBytesToString(content))
ctx.Data["IsProfileReadmePlain"] = true
}
}
}

18
routers/web/shared/user/header.go
View file

@ -22,6 +22,7 @@ import (
"forgejo.org/modules/markup/markdown"
"forgejo.org/modules/optional"
"forgejo.org/modules/setting"
"forgejo.org/routers/web/repo"
"forgejo.org/services/context"
)
@ -104,7 +105,22 @@ func FindUserProfileReadme(ctx *context.Context, doer *user_model.User) (profile
if commit, err := profileGitRepo.GetBranchCommit(profileDbRepo.DefaultBranch); err != nil {
log.Error("FindUserProfileReadme failed to GetBranchCommit: %v", err)
} else {
profileReadmeBlob, _ = commit.GetBlobByFoldedPath("README.md")
tree, err := commit.SubTree("")
if err != nil {
log.Error("FindUserProfileReadme failed to get SubTree: %v", err)
} else {
entries, err := tree.ListEntries()
if err != nil {
log.Error("FindUserProfileReadme failed to list entries: %v", err)
} else {
_, readmeEntry, err := repo.FindReadmeFileInEntries(ctx, entries, true)
if err != nil {
log.Error("FindUserProfileReadme failed to find readme in entries: %v", err)
} else if readmeEntry != nil {
profileReadmeBlob = readmeEntry.Blob()
}
}
}
}
}
}

12
routers/web/user/profile.go
View file

@ -8,6 +8,8 @@ package user
import (
"errors"
"fmt"
gotemplate "html/template"
"io"
"net/http"
"path"
"strings"
@ -269,8 +271,10 @@ func prepareUserProfileTabData(ctx *context.Context, showPrivate bool, profileDb
} else {
defer rc.Close()
if markupType := markup.Type(profileReadme.Name()); markupType != "" {
if profileContent, err := markdown.RenderReader(&markup.RenderContext{
Ctx: ctx,
Type: markupType,
GitRepo: profileGitRepo,
Links: markup.Links{
// Give the repo link to the markdown render for the full link of media element.
@ -287,6 +291,14 @@ func prepareUserProfileTabData(ctx *context.Context, showPrivate bool, profileDb
} else {
ctx.Data["ProfileReadme"] = profileContent
}
} else {
content, err := io.ReadAll(rc)
if err != nil {
log.Error("Read readme content failed: %v", err)
}
ctx.Data["ProfileReadme"] = gotemplate.HTMLEscapeString(util.UnsafeBytesToString(content))
ctx.Data["IsProfileReadmePlain"] = true
}
}
default: // default to "repositories"
repos, count, err = repo_model.SearchRepository(ctx, &repo_model.SearchRepoOptions{

8
templates/org/home.tmpl
View file

@ -11,7 +11,13 @@
<div class="ui mobile reversed stackable grid">
<div class="ui {{if .ShowMemberAndTeamTab}}eleven wide{{end}} column">
{{if .ProfileReadme}}
<div id="readme_profile" class="markup">{{.ProfileReadme}}</div>
<div id="readme_profile" class="{{if not .IsProfileReadmePlain}}markup{{end}}">
{{if .IsProfileReadmePlain}}
<pre>{{.ProfileReadme}}</pre>
{{else}}
{{.ProfileReadme}}
{{end}}
</div>
{{end}}
{{template "shared/repo_search" .}}
{{template "explore/repo_list" .}}

8
templates/user/profile.tmpl
View file

@ -51,7 +51,13 @@
{{else if eq .TabName "followers"}}
{{template "repo/user_cards" .}}
{{else if eq .TabName "overview"}}
<div id="readme_profile" class="markup">{{.ProfileReadme}}</div>
<div id="readme_profile" class="{{if not .IsProfileReadmePlain}}markup{{end}}">
{{if .IsProfileReadmePlain}}
<pre>{{.ProfileReadme}}</pre>
{{else}}
{{.ProfileReadme}}
{{end}}
</div>
{{else}}
{{template "shared/repo_search" .}}
{{template "explore/repo_list" .}}

10
tests/integration/org_profile_test.go
View file

@ -64,7 +64,15 @@ func TestOrgProfile(t *testing.T) {
checkReadme(t, "README.md", "README.md", 1)
checkReadme(t, "readme.md", "readme.md", 1)
checkReadme(t, "ReadMe.mD", "ReadMe.mD", 1)
checkReadme(t, "readme.org does not render", "README.org", 0)
checkReadme(t, "readme.org", "README.org", 1)
checkReadme(t, "README.en-us.md", "README.en-us.md", 1)
checkReadme(t, "README.en.md", "README.en.md", 1)
checkReadme(t, "README.txt", "README.txt", 1)
checkReadme(t, "README", "README", 1)
checkReadme(t, "README.mdown", "README.mdown", 1)
checkReadme(t, "README.i18n.md", "README.i18n.md", 1)
checkReadme(t, "readmee", "readmee", 0)
checkReadme(t, "test.md", "test.md", 0)
t.Run("readme-size", func(t *testing.T) {
defer tests.PrintCurrentTest(t)()

10
tests/integration/user_profile_test.go
View file

@ -64,7 +64,15 @@ func TestUserProfile(t *testing.T) {
checkReadme(t, "README.md", "README.md", 1)
checkReadme(t, "readme.md", "readme.md", 1)
checkReadme(t, "ReadMe.mD", "ReadMe.mD", 1)
checkReadme(t, "readme.org does not render", "README.org", 0)
checkReadme(t, "readme.org", "README.org", 1)
checkReadme(t, "README.en-us.md", "README.en-us.md", 1)
checkReadme(t, "README.en.md", "README.en.md", 1)
checkReadme(t, "README.txt", "README.txt", 1)
checkReadme(t, "README", "README", 1)
checkReadme(t, "README.mdown", "README.mdown", 1)
checkReadme(t, "README.i18n.md", "README.i18n.md", 1)
checkReadme(t, "readmee", "readmee", 0)
checkReadme(t, "test.md", "test.md", 0)
t.Run("readme-size", func(t *testing.T) {
defer tests.PrintCurrentTest(t)()