From 4b8a1d21f31e1d447de36b5fdaf1c4407d38f969 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 3 May 2021 21:41:42 +0200 Subject: [PATCH] CI: Add `--doctool` check to find missing classref updates This will enforce that PRs properly sync the class reference templates to match their changes to the public API, and help notice binding bugs in the process (e.g. missing enum bindings, unexpected API changes or missing argument names). This should also serve as a reminder to contributors that their changes impact the scripting API and might warrant actually filling the descriptions for the new methods/properties/etc. (cherry picked from commit b3884122701232fb76a4a72ce2352d913d364e2d) --- .github/workflows/linux_builds.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/workflows/linux_builds.yml b/.github/workflows/linux_builds.yml index b77cea47561..85418032f11 100644 --- 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