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.
This commit is contained in:
parent
62bea72601
commit
b388412270
1 changed files with 8 additions and 0 deletions
8
.github/workflows/linux_builds.yml
vendored
8
.github/workflows/linux_builds.yml
vendored
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue