[libcxx-commits] [llvm] [libcxx] [libc++][CI] Moves CI badge to main README. (PR #77247)

Mark de Wever via libcxx-commits libcxx-commits at lists.llvm.org
Sun Jan 7 10:59:26 PST 2024


https://github.com/mordante created https://github.com/llvm/llvm-project/pull/77247

The current CI badge is currently in libc++ documentation. This does not seem the right place:
- The typical location on GitHub is on the main README.
- The documentation is shipped as part of the release:
  - This link does not work in off-line mode. Currently our documentation works in off-line mode.
  - The status in the release documentation does not reflect the status of the shipped library. So users looking at it may see a red status and get confused.

This moves the badge to the README.

>From fd186b8f12f627f48c0329601d1b9a6f6ab0eb9d Mon Sep 17 00:00:00 2001
From: Mark de Wever <koraq at xs4all.nl>
Date: Sun, 7 Jan 2024 19:48:02 +0100
Subject: [PATCH] [libc++][CI] Moves CI badge to main README.

The current CI badge is currently in libc++ documentation. This does not
seem the right place:
- The typical location on GitHub is on the main README.
- The documentation is shipped as part of the release:
  - This link does not work in off-line mode. Currently our documentation
    works in off-line mode.
  - The status in the release documentation does not reflect the status of
    the shipped library. So users looking at it may see a red status and
    get confused.

This moves the badge to the README.
---
 README.md             | 1 +
 libcxx/docs/index.rst | 4 ----
 2 files changed, 1 insertion(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 4ae7eaf9b083a5..8202ff61d42fb9 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # The LLVM Compiler Infrastructure
 
 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/llvm/llvm-project/badge)](https://securityscorecards.dev/viewer/?uri=github.com/llvm/llvm-project)
+[![libc++](https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml/badge.svg?branch=main&event=schedule)](https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml?query=event%3Aschedule)
 
 Welcome to the LLVM project!
 
diff --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index c7769bae6bb17d..bcaf99495b8fac 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -202,10 +202,6 @@ Design Documents
 Build Bots and Test Coverage
 ============================
 
-.. 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?query=event%3Aschedule
-   :alt: Build and Test libc++
-
 * `Github Actions CI pipeline <https://github.com/llvm/llvm-project/actions/workflows/libcxx-build-and-test.yaml>`_
 * `Buildkite CI pipeline <https://buildkite.com/llvm-project/libcxx-ci>`_
 * `LLVM Buildbot Builders <https://lab.llvm.org/buildbot>`_



More information about the libcxx-commits mailing list