Skip to content

KAFKA-18241: add docs check to CI #18183

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Dec 18, 2024
Merged

KAFKA-18241: add docs check to CI #18183

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a1aa07f
draft a version
m1a2st Dec 14, 2024
aa279b5
merge run into Compile and validate
m1a2st Dec 15, 2024
356e8a3
Draft a version
m1a2st Dec 15, 2024
da8347e
Merge branch 'trunk' into KAFKA-18241
m1a2st Dec 15, 2024
976d94a
revert
m1a2st Dec 15, 2024
79b2a9d
addressed by comments
m1a2st Dec 18, 2024
ebcb246
addressed by comments
m1a2st Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,13 @@ jobs:
# --no-scan: For public fork PRs, we won't attempt to publish the scan
run: |
./gradlew --build-cache --info $SCAN_ARG check -x test
./gradlew siteDocTar
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @chia7712's comment was to move the siteDocTar into this "Compile and validate" and add a subsequent step to verify the contents (e.g., "Check Site Docs"). Having two gradle commands in one step makes it harder to see what failed without digging into the logs.

tar zxvf core/build/distributions/kafka_2.13-$(./gradlew properties | grep version: | awk '{print $NF}' | head -n 1)-site-docs.tgz
if find ./site-docs/generated -type f -exec grep -L "." {} \; | grep -q "."; then
echo "One or more documentation files are empty!" >&2
find ./site-docs/generated -type f -exec grep -L "." {} \; >&2
exit 1
fi
- name: Archive check reports
if: always()
uses: actions/upload-artifact@v4
Expand Down
Loading