Add libc++ main builder status badge #75283
Conversation
llvmbot
added
the
libc++
|
@llvm/pr-subscribers-libcxx Author: Eric (EricWF) ChangesFull diff: https://github.com/llvm/llvm-project/pull/75283.diff 1 Files Affected:
diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index e8b4a95dbcffae..6112181d02f7b8 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -4,6 +4,10 @@
"libc++" C++ Standard Library
=============================
+.. image:: https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml/badge.svg?branch=main&event=schedule
+ :target: https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml
+ :alt: Build and Test libc++
+
Overview
========
|
| @@ -67,6 +67,10 @@ Getting Started with libc++ | |||
| Current Status | |||
| ============== | |||
|
|
|||
| .. image:: https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml/badge.svg?branch=main&event=schedule | |||
There was a problem hiding this comment.
IMO this is a really bad place to put this. I'm pretty sure most people don't care whether our CI is currently green, and this has nothing to do with the text below.
There was a problem hiding this comment.
I have to agree to some extent. This is user documentation, not libc++ developer documentation. Also, we publish this page and freeze it for releases, but this link is relative so for example if you look at the page for the LLVM 18 release, it will contain this badge which may go green/red depending on the weather. This seems undesirable.
Instead, I think a better place to put this badge would be on the LLVM monorepo README which we can see at a glance by just looking at the repo -- other projects could consider doing the same thing and we'd have some kind of table that shows the status of all projects.
There was a problem hiding this comment.
Cool. I'll send a change. But I would like this on the website somewhere. I can put it down next to the builders.
There was a problem hiding this comment.
Just curious, but why not put it in the main LLVM README? Then the status is directly visible from the main GitHub page. This is the typical location for badges.
|
The goal was to document where to find the builders from the libc++ website.
I have no opposition to adding it other places as well.
…On Wed, Dec 20, 2023, 2:22 PM Mark de Wever ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In libcxx/docs/index.rst
<#75283 (comment)>:
> @@ -67,6 +67,10 @@ Getting Started with libc++
Current Status
==============
+.. image:: https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml/badge.svg?branch=main&event=schedule
Just curious, but why not put it in the main LLVM README? Then the status
is directly visible from the main GitHub page. This is the typical location
for badges.
—
Reply to this email directly, view it on GitHub
<#75283 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAI7G27FPI6QLKSI3DGTOCDYKM3IPAVCNFSM6AAAAABASSSJJOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTOOJRGUZDINRTHE>
.
You are receiving this because you modified the open/close state.Message
ID: ***@***.***>
|
No description provided.