[llvm] [Github] Add support for building libc docs in Github actions (PR #69824)

Aiden Grossman via llvm-commits llvm-commits at lists.llvm.org
Tue Oct 24 12:03:38 PDT 2023


https://github.com/boomanaiden154 updated https://github.com/llvm/llvm-project/pull/69824

>From d5b56cbd02c398f1308fdbec5826745fc7a12613 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 21 Oct 2023 02:15:51 -0700
Subject: [PATCH 1/3] [Github] Add support for building libc docs in Github
 actions

This patch adds support for building the libc docs in Github actions.
This eanbles easily diagnosing doc build failures/warnings in PRs and at
the tip of tree.
---
 .github/workflows/docs.yml | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 70b0a29b871e0f9..ace184eeb6f88a1 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -19,6 +19,7 @@ on:
       - 'lldb/docs/**'
       - 'libunwind/docs/**'
       - 'libcxx/docs/**'
+      - 'libc/docs/**'
   pull_request:
     paths:
       - 'llvm/docs/**'
@@ -27,6 +28,7 @@ on:
       - 'lldb/docs/**'
       - 'libunwind/docs/**'
       - 'libcxx/docs/**'
+      - 'libc/docs/**'
 
 jobs:
   check-docs-build:
@@ -59,6 +61,8 @@ jobs:
               - 'libunwind/docs/**'
             libcxx:
               - 'libcxx/docs/**'
+            libc:
+              - 'libc/docs/**'
       - name: Fetch LLVM sources (PR)
         if: ${{ github.event_name == 'pull_request' }}
         uses: actions/checkout at v4
@@ -107,4 +111,10 @@ jobs:
         run: |
           cmake -B libcxx-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libcxxabi;libcxx" -DLLVM_ENABLE_SPHINX=ON ./runtimes
           TZ=UTC ninja -C libcxx-build docs-libcxx-html
+      - name: Build libc docs
+        if: steps.docs-changed-subprojects.outputs.libc_any_changed == 'true'
+        run: |
+          cmake -B libc-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libc" -DLLVM_ENABLE_SPHINX=ON ./runtimes
+          TZ=UTC ninja -C libc-build docs-libc-html
+
 

>From 7fbe4462a068e0e4516e88940ee6356842c49c68 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Mon, 23 Oct 2023 20:32:42 -0700
Subject: [PATCH 2/3] Address some reviewer feedback

---
 .github/workflows/docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index ace184eeb6f88a1..03b18f6da1b7458 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -115,6 +115,6 @@ jobs:
         if: steps.docs-changed-subprojects.outputs.libc_any_changed == 'true'
         run: |
           cmake -B libc-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libc" -DLLVM_ENABLE_SPHINX=ON ./runtimes
-          TZ=UTC ninja -C libc-build docs-libc-html
+          TZ=UTC ninja -C docs-libc-html
 
 

>From c587685d34a7f23d03a58b3c8e866db50f5a97a9 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Tue, 24 Oct 2023 12:03:21 -0700
Subject: [PATCH 3/3] Remove extra blank line from bad rebase

---
 .github/workflows/docs.yml | 1 -
 1 file changed, 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 03b18f6da1b7458..a0670625bb3e344 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -117,4 +117,3 @@ jobs:
           cmake -B libc-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_RUNTIMES="libc" -DLLVM_ENABLE_SPHINX=ON ./runtimes
           TZ=UTC ninja -C docs-libc-html
 
-



More information about the llvm-commits mailing list