-
Notifications
You must be signed in to change notification settings - Fork 11.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Github] Add support for building libc docs in Github actions #69824
Conversation
@llvm/pr-subscribers-github-workflow Author: Aiden Grossman (boomanaiden154) ChangesThis 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. Full diff: https://github.com/llvm/llvm-project/pull/69824.diff 1 Files Affected:
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 2900f73c77c5a66..aa82043e62eb561 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -15,10 +15,12 @@ on:
paths:
- 'llvm/docs/**'
- 'clang/docs/**'
+ - 'libc/docs/**'
pull_request:
paths:
- 'llvm/docs/**'
- 'clang/docs/**'
+ - 'libc/docs/**'
jobs:
check-docs-build:
@@ -47,6 +49,8 @@ jobs:
- 'llvm/docs/**'
clang:
- 'clang/docs/**'
+ libc:
+ - 'libc/docs/**'
- name: Setup Python env
uses: actions/setup-python@v4
with:
@@ -69,4 +73,10 @@ jobs:
run: |
cmake -B clang-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang" -DLLVM_ENABLE_SPHINX=ON ./llvm
TZ=UTC ninja -C clang-build docs-clang-html docs-clang-man
+ - 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
+
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall good, but there are some changes needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
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.
1ae2875
to
c587685
Compare
#69824 added libc build, but missed the folder in ninja command, is causing failures. ninja: fatal: chdir to 'docs-libc-html' - No such file or directory ninja: Entering directory `docs-libc-html'
llvm/llvm-project#69824 added libc build, but missed the folder in ninja command, is causing failures. ninja: fatal: chdir to 'docs-libc-html' - No such file or directory ninja: Entering directory `docs-libc-html'
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.