Merge pull request #48426 from akien-mga/3.x-ci-doctool-check

[3.x] CI: Add `--doctool` check to find missing classref updates
godotengine · May 3, 2021 · 0481a9a · 0481a9a
2 parents 62bea72 + b388412
commit 0481a9a
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/.github/workflows/linux_builds.yml b/.github/workflows/linux_builds.yml
@@ -208,3 +208,11 @@ jobs:
  echo "----- Run and test project -----"
  DRI_PRIME=0 xvfb-run bin/godot.x11.tools.64s 30 --video-driver GLES3 --audio-driver Dummy --path test_project 2>&1 | tee sanitizers_log.txt || true
  misc/scripts/check_ci_log.py sanitizers_log.txt
+
+ # Check class reference
+ - name: Check for class reference updates
+ run: |
+ echo "Running --doctool to see if this changes the public API without updating the documentation."
+ echo -e "If a diff is shown, it means that your code/doc changes are incomplete and you should update the class reference with --doctool.\n\n"
+ DRI_PRIME=0 xvfb-run bin/godot.x11.tools.64s --doctool . 2>&1 > /dev/null || true
+ git diff --color --exit-code