Browse Source

Merge pull request #48410 from akien-mga/ci-doctool-check

CI: Add `--doctool` check to find missing classref updates
Rémi Verschelde 4 years ago
parent
commit
f47c285f67
1 changed files with 17 additions and 0 deletions
  1. 17 0
      .github/workflows/linux_builds.yml

+ 17 - 0
.github/workflows/linux_builds.yml

@@ -70,6 +70,23 @@ jobs:
         run: |
         run: |
           ./bin/godot.linuxbsd.opt.tools.64 --test
           ./bin/godot.linuxbsd.opt.tools.64 --test
 
 
+      # Download, unzip and setup SwiftShader library [d4550ab8d3f]
+      - name: Download SwiftShader
+        run: |
+          wget https://github.com/qarmin/gtk_library_store/releases/download/3.24.0/swiftshader.zip
+          unzip swiftshader.zip
+          rm swiftshader.zip
+          curr="$(pwd)/libvk_swiftshader.so"
+          sed -i "s|PATH_TO_CHANGE|$curr|" vk_swiftshader_icd.json
+
+      # 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"
+          VK_ICD_FILENAMES=$(pwd)/vk_swiftshader_icd.json DRI_PRIME=0 xvfb-run bin/godot.linuxbsd.opt.tools.64 --doctool . 2>&1 > /dev/null || true
+          git diff --color --exit-code
+
       - uses: actions/upload-artifact@v2
       - uses: actions/upload-artifact@v2
         with:
         with:
           name: ${{ github.job }}
           name: ${{ github.job }}