-
Notifications
You must be signed in to change notification settings - Fork 14.3k
[Github] Add clang-tools-extra docs to CI #69827
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
Conversation
This patch adds the clang-tools-extra docs to the Github CI job that builds docs, enabling the ability to easily ensure the docs build properly without warnings in PRs and at the tip of tree.
The |
@llvm/pr-subscribers-github-workflow Author: Aiden Grossman (boomanaiden154) ChangesThis patch adds the clang-tools-extra docs to the Github CI job that builds docs, enabling the ability to easily ensure the docs build properly without warnings in PRs and at the tip of tree. Full diff: https://github.com/llvm/llvm-project/pull/69827.diff 1 Files Affected:
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 2900f73c77c5a66..6d91112cca5518f 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -15,10 +15,12 @@ on:
paths:
- 'llvm/docs/**'
- 'clang/docs/**'
+ - 'clang-tools-extra/docs/**'
pull_request:
paths:
- 'llvm/docs/**'
- 'clang/docs/**'
+ - 'clang-tools-extra/docs/**'
jobs:
check-docs-build:
@@ -47,6 +49,8 @@ jobs:
- 'llvm/docs/**'
clang:
- 'clang/docs/**'
+ clang-tools-extra:
+ - 'clang-tools-extra/docs/**'
- name: Setup Python env
uses: actions/setup-python@v4
with:
@@ -69,4 +73,9 @@ 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 clang-tools-extra docs
+ if: steps.docs-changed-subprojects.outputs.clang-tools-extra_any_changed == 'true'
+ run: |
+ cmake -B clang-tools-extra-build -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -DLLVM_ENABLE_SPHINX=ON ./llvm
+ TZ=UTC ninja -C clang-tools-extra-build docs-clang-tools-html docs-clang-tools-man
|
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.
I just pushed "fix" for those warnings.
Ah, that's why it was magically fixed when I went to reproduce it so that I could work on fixing it. Thanks! |
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.
Thanks for the reviews on all of these @tstellar. Probably should've consolidated them a little bit better to make it easier on your end but wanted to make sure I wasn't missing any project specific subtleties. |
This patch adds the clang-tools-extra docs to the Github CI job that builds docs, enabling the ability to easily ensure the docs build properly without warnings in PRs and at the tip of tree.