github-starred/gitea
2
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-03-22 22:45:27 -05:00
Code Issues 2.6k Packages Projects Releases 100 Wiki Activity

Profile readme should support any rearme file, not only README.md. Ther should be no hardcode. #11823

New Issue
Closed
opened 2025-11-02 09:48:53 -06:00 by GiteaMirror · 7 comments
GiteaMirror commented 2025-11-02 09:48:53 -06:00
Owner
Copy Link

Originally created by @KOLANICH on GitHub (Oct 10, 2023).

Description

blob, err := commit.GetBlobByPath("README.md")

is hardcoded in c090f87a8d

It has several issues:

  1. ReadMe can be not in Markdown format
  2. ReadMe file can have another name, i.e. ReadMe.md

Instead it should use generic interfaces to deal with readmes.

Also: the mere fact this PR has been landed means there are serious problems with PR review in this project.

Gitea Version

Forgejo 1.20.4+0-65-g0fe7af40a

Can you reproduce the bug on the Gitea demo site?

Yes

Log Gist

No response

Screenshots

No response

Git Version

No response

Operating System

No response

How are you running Gitea?

Just use Codeberg

Database

None

Originally created by @KOLANICH on GitHub (Oct 10, 2023). ### Description ```go blob, err := commit.GetBlobByPath("README.md") ``` is hardcoded in https://github.com/go-gitea/gitea/commit/c090f87a8db5b51e0aa9c7278b38ddc862c048ac It has several issues: 1. ReadMe can be not in Markdown format 2. ReadMe file can have another name, i.e. `ReadMe.md` Instead it should use generic interfaces to deal with readmes. Also: the mere fact this PR has been landed means there are serious problems with PR review in this project. ### Gitea Version Forgejo 1.20.4+0-65-g0fe7af40a ### Can you reproduce the bug on the Gitea demo site? Yes ### Log Gist _No response_ ### Screenshots _No response_ ### Git Version _No response_ ### Operating System _No response_ ### How are you running Gitea? Just use Codeberg ### Database None
GiteaMirror commented 2025-11-02 09:48:54 -06:00
Author
Owner
Copy Link

@jolheiser commented on GitHub (Oct 10, 2023):

Well, currently it works as described. It displays only markdown, and only README.md.

You are more than welcome to propose enhancements (as you have), however it's unfair to criticize an implementation simply because it doesn't do all the things you want it to do. Iteration on features is always possible.

Your suggestions are certainly possible, and I'd be open to a PR for them.

@jolheiser commented on GitHub (Oct 10, 2023): Well, currently it works as described. It displays only markdown, and only `README.md`. You are more than welcome to propose enhancements (as you have), however it's unfair to criticize an implementation simply because it doesn't do all the things you want it to do. Iteration on features is always possible. Your suggestions are certainly possible, and I'd be open to a PR for them.
GiteaMirror commented 2025-11-02 09:48:55 -06:00
Author
Owner
Copy Link

@eeyrjmr commented on GitHub (Oct 10, 2023):

What if a README.md, ReadMe.md, readme.md and a ReAdMe.md file exist at the same level, what should be rendered?

This way it is clear which file will be rendered on the repository view

@eeyrjmr commented on GitHub (Oct 10, 2023): What if a README.md, ReadMe.md, readme.md and a ReAdMe.md file exist at the same level, what should be rendered? This way it is clear which file will be rendered on the repository view
GiteaMirror commented 2025-11-02 09:48:55 -06:00
Author
Owner
Copy Link

@wxiaoguang commented on GitHub (Oct 10, 2023):

Also: the mere fact this PR has been landed means there are serious problems with PR review in this project.

https://github.com/go-gitea/gitea/blob/main/CODE_OF_CONDUCT.md

  • Be friendly and welcoming.
  • Be respectful.
  • Be constructive.

And I see you are using Forgejo, I guess you should criticize the Forgejo team that they do not understand the code / they can't implement it / they included a commit in their codebase you don't like.

Gitea community always welcome friendly users and would try to help them to resolve problems.

@wxiaoguang commented on GitHub (Oct 10, 2023): > Also: the mere fact this PR has been landed means there are serious problems with PR review in this project. https://github.com/go-gitea/gitea/blob/main/CODE_OF_CONDUCT.md * Be friendly and welcoming. * Be respectful. * Be constructive. And I see you are using Forgejo, I guess you should criticize the Forgejo team that they do not understand the code / they can't implement it / they included a commit in their codebase you don't like. Gitea community always welcome friendly users and would try to help them to resolve problems.
GiteaMirror commented 2025-11-02 09:48:55 -06:00
Author
Owner
Copy Link

@delvh commented on GitHub (Oct 10, 2023):

I hope everyone has calmed down by now.
Both sides are a bit too aggressive in their wording here for my taste.

@delvh commented on GitHub (Oct 10, 2023): I hope everyone has calmed down by now. Both sides are a bit too aggressive in their wording here for my taste.
GiteaMirror commented 2025-11-02 09:48:55 -06:00
Author
Owner
Copy Link

@KOLANICH commented on GitHub (Oct 10, 2023):

What if a README.md, ReadMe.md, readme.md and a ReAdMe.md file exist at the same level, what should be rendered?

IMHO rendering of readmes for profiles and orgs should use the impl that is used when rendering readmes within repos. Those issues arise for repos too, but for them they are solved in some way. There is no ideal or perfect way to solve the issue of resolving ambiguity when multiple readme files are present (there are multiple possible ways: to create a list of filename stems and types and assign priorities to them like formatPriority << 8 | stemPriority, or to measure information content within files and choose the most informative of them, or evaluate quality of the text with a neural network, or combine all the files, or show none of them and instead show an error message, or choose (pseudo)randomly; each way has own pros and cons), but some way still has to be used. And it is used: for repos readmes are rendered fine (not as good as on GitHub and GitLab, there are some issues (and I may create more issues about them), but still pretty fine). I insist that a readme for a profile or an org is just a readme for a .profile repo, which is just additionally rendered on profile or org page. So the algos for repos should be used to choose the files to be rendered. I can even expect that rendering can be done once (on push, on first view or a hybrid strategy: on push do a scheduling to do rendering on idle after some time, then it can also be done on first visit), and then cached.

@KOLANICH commented on GitHub (Oct 10, 2023): >What if a README.md, ReadMe.md, readme.md and a ReAdMe.md file exist at the same level, what should be rendered? IMHO rendering of readmes for profiles and orgs should use the impl that is used when rendering readmes within repos. Those issues arise for repos too, but for them they are solved in some way. There is no ideal or perfect way to solve the issue of resolving ambiguity when multiple readme files are present (there are multiple possible ways: to create a list of filename stems and types and assign priorities to them like `formatPriority << 8 | stemPriority`, or to measure information content within files and choose the most informative of them, or evaluate quality of the text with a neural network, or combine all the files, or show none of them and instead show an error message, or choose (pseudo)randomly; each way has own pros and cons), but some way still has to be used. And it is used: for repos readmes are rendered fine (not as good as on GitHub and GitLab, there are some issues (and I may create more issues about them), but still pretty fine). I insist that a readme for a profile or an org is just a readme for a `.profile` repo, which is just additionally rendered on profile or org page. So the algos for repos should be used to choose the files to be rendered. I can even expect that rendering can be done once (on push, on first view or a hybrid strategy: on push do a scheduling to do rendering on idle after some time, then it can also be done on first visit), and then cached.
GiteaMirror commented 2025-11-02 09:48:55 -06:00
Author
Owner
Copy Link

@kzarist commented on GitHub (Nov 20, 2023):

I wanted to be able to use my usual README.org on my .profile "incorrect" spelling of README.md is not the only reason

@kzarist commented on GitHub (Nov 20, 2023): I wanted to be able to use my usual `README.org` on my .profile "incorrect" spelling of README.md is not the only reason
GiteaMirror commented 2025-11-02 09:48:56 -06:00
Author
Owner
Copy Link

@lunny commented on GitHub (Nov 20, 2023):

Please open new issue to do a proposal.

@lunny commented on GitHub (Nov 20, 2023): Please open new issue to do a proposal.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
$20
$250
$50
$500
backport/done
💎 Bounty
docs-update-needed
good first issue
hacktoberfest
issue/bounty
issue/confirmed
issue/critical
issue/duplicate
issue/needs-feedback
issue/not-a-bug
issue/regression
issue/stale
issue/workaround
lgtm/need 2
modifies/api
modifies/translation
outdated/backport/v1.18
outdated/theme/markdown
outdated/theme/timetracker
performance/bigrepo
performance/cpu
performance/memory
performance/speed
pr/breaking
proposal/accepted
proposal/rejected
pr/wip
pull-request
Mirrored from GitHub Pull Request
 reviewed/wontfix
💰 Rewarded
skip-changelog
status/blocked
topic/accessibility
topic/api
topic/authentication
topic/build
topic/code-linting
topic/commit-signing
topic/content-rendering
topic/deployment
topic/distribution
topic/federation
topic/gitea-actions
topic/issues
topic/lfs
topic/mobile
topic/moderation
topic/packages
topic/pr
topic/projects
topic/repo
topic/repo-migration
topic/security
topic/theme
topic/ui
topic/ui-interaction
topic/ux
topic/webhooks
topic/wiki
type/bug
type/deprecation
type/docs
type/enhancement
type/feature
type/miscellaneous
type/proposal
type/question
type/refactoring
type/summary
type/testing
type/upstream
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#11823
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?