ci: display warnings on doc-building CI check and make the job fail (#…

…1492)

Co-authored-by: theodu <[email protected]>

.github/workflows/ci.yml

@@ -138,4 +138,15 @@ jobs:
           pip install -e ".[dev]"
 
       - name: Build
-        run: mkdocs build
+        run: |
+          mkdocs build 2>&1 | tee doc-build.log
+
+      - name: Look for Warnings
+        run: |
+          if grep -q "WARNING" doc-build.log; then
+            echo $(grep "WARNING" doc-build.log)
+            echo "::error::Documentation build completed with warnings"
+            exit 1
+          else
+            echo "Documentation build completed successfully"
+          fi

src/kili/entrypoints/mutations/label/__init__.py

@@ -131,7 +131,7 @@ def append_to_labels(
         label_type: LabelType = "DEFAULT",
         project_id: Optional[str] = None,
         seconds_to_label: Optional[int] = 0,
-    ):
+    ) -> Dict[Literal["id"], str]:
         """!!! danger "[DEPRECATED]"
             append_to_labels method is deprecated. Please use append_labels instead.
             This new function allows to import several labels 10 times faster.

src/kili/entrypoints/queries/plugins/__init__.py

@@ -2,7 +2,7 @@
 
 import json
 from datetime import datetime
-from typing import Optional
+from typing import Dict, List, Optional
 
 from typeguard import typechecked
 
@@ -95,7 +95,7 @@ def get_plugin_status(
         self,
         plugin_name: str,
         verbose: bool = True,
-    ):
+    ) -> str:
         """Update a plugin with new code.
 
         Args:
@@ -116,7 +116,7 @@ def get_plugin_status(
     def list_plugins(
         self,
         fields: ListOrTuple[str] = ("name", "projectIds", "id", "createdAt", "updatedAt"),
-    ):
+    ) -> List[Dict]:
         # pylint: disable=line-too-long
         """List all plugins from your organization.