mirror of https://github.com/apache/kafka.git
KAFKA-18241: add docs check to CI (#18183)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>, David Arthur <mumrah@gmail.com>
This commit is contained in:
parent
8150e7bf79
commit
08efe735a4
|
@ -117,7 +117,7 @@ jobs:
|
|||
# --scan: Publish the build scan. This will only work on PRs from apache/kafka and trunk
|
||||
# --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 --build-cache --info $SCAN_ARG check siteDocTar -x test
|
||||
- name: Archive check reports
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
|
@ -137,6 +137,16 @@ jobs:
|
|||
run: python .github/scripts/rat.py
|
||||
env:
|
||||
GITHUB_WORKSPACE: ${{ github.workspace }}
|
||||
- name: Check generated documentation
|
||||
# Check if there are any empty files under ./site-docs/generated, If any empty files are found, print an error
|
||||
# message and list the empty files
|
||||
run: |
|
||||
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
|
||||
|
||||
test:
|
||||
needs: [validate, load-catalog]
|
||||
|
|
Loading…
Reference in New Issue