search

go-gitea / gitea

Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD
https://gitea.com
MIT License
43.25k stars 5.32k forks source link

Feature request: Project badges #5633

Open ntimo opened 5 years ago

ntimo commented 5 years ago

Description

It would be super nice if you could add bagdes to a project like the way you can add them in Gitlab this would enable repository maintainers to clearly show the status of their pipelines or code coverage reports without having to out the into the readme.md. The badges should addable via the repo settings with a link_url and a image_url setting.

Screenshots

Example from GitLab: gitlab-project-badges

StevenPolley commented 5 years ago

I haven't used gitlab but aren't these badges typically a part of the CICD system and not the version control system?

ntimo commented 5 years ago

Kind of yes, but you can also use them to display your code coverage report from SonarQube for example :)

strk commented 2 years ago

It would be great to be able to finally STOP polluting the README.md with all the non-human-readable crap

lunny commented 2 years ago

But you can preview the README badges when you clone it locally.

wxiaoguang commented 2 years ago

What about putting the badges in the repository description? Then render these images in Markdown.

strk commented 2 years ago

But you can preview the README badges when you clone it locally.

Do people actually tend to open README.md files with tools capable of rendering the images in them ? Myself I always open README files with a pager (less,more,view,...) just expecting text-only, nicely formatted to be somewhat machine-readable, but still for text-only (console?) consumption!

Badges in repository description I guess would be a possible workaround, but proper space for badges sounds even better to me, given the widespread use of badges.

strk commented 2 years ago

I just experienced that the GitLab way of doing this has the limit of NOT allowing people to send pull-requests to add badges, so while I still think that it is nice to have an ad-hoc space for rendering the badges, it would be also good for the badges information to be in a file in the repository, like .badges.yml or something. That way different mirrors might eventually end up rendering the same badges too

strk commented 2 years ago

Or .badges.md if people really do render the markdown-with-images locally. Or .header.md to be rendered before README.md, to be more generic and less intrusive in the life of text-only console-based reading of README files ?

lafriks commented 2 years ago

.yaml could be better option imho, also would be nice to allow way for badges to pass branch/tag name in image url, so that it would be possible to link to specific version/branch docs/build status etc

belliash commented 1 year ago

Gitea gained actions (CI/CD) feature. Can this be implemented now as a part of Gitea Actions?

lunny commented 1 year ago

Gitea gained actions (CI/CD) feature. Can this be implemented now as a part of Gitea Actions?

I think they are different features.

senare commented 9 months ago

Yes, please don't bundle this with Gitea Actions !

I think use case is bigger and not all of use use Gitea Actions ...

robe2 commented 8 months ago

But you can preview the README badges when you clone it locally.

Do people actually tend to open README.md files with tools capable of rendering the images in them ? Myself I always open README files with a pager (less,more,view,...) just expecting text-only, nicely formatted to be somewhat machine-readable, but still for text-only (console?) consumption!

I do yes. VS Code can preview markdown and see the badges. But to be honest, only reason I preview is when I edit.