ci: Improve workflows

* fix: Align priority moves with generalsio

* fix: Make online observations include priority

* ci: Add Code Embedder by @kvankova to keep READMEs up-to-date

* refactor(exceptions): make exceptions extensible

Next step should be to utilize exceptions instead of `assert`. The main
advantage of it is that you can catch specific exception instead of
`AssertionError`.

* ci: fix code-embedder action

The manual setting of referrence breaks the checkout action. I am not
entirely sure why it was needed, or what was the intended behaviour, but
checkout action by default switches to feature branch (branch which is
used as source for PR).

* ci: rework GitHub actions

It is more of an update and simplification of triggeres and update of
some action versions.

* chore: Fix pytests

---------

Co-authored-by: Juraj Paluba <[email protected]>

.github/workflows/code-embedder.yml

@@ -9,10 +9,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.pull_request.head.ref }}
 
       - name: Run code embedder
-        uses: kvankova/code-embedder@v0.3.0
+        uses: kvankova/code-embedder@v0.4.0
         env:
           GITHUB_TOKEN: ${{ secrets.CODE_EMBEDDER }}

.github/workflows/codeql.yml

@@ -33,7 +33,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/commit-message.yml

@@ -1,14 +1,13 @@
 name: Check commits for Conventional Commits practices
 
 on:
-  pull_request:
-    branches: [master]
+  push:
 
 jobs:
   check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Check Commit Messages
         uses: webiny/[email protected]
         with:

.github/workflows/pre-commit.yml

@@ -3,19 +3,17 @@ name: CI
 on:
   workflow_dispatch:
   push:
-  pull_request:
-    branches: [master]
 
 jobs:
   ci:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
 

generals/__init__.py

@@ -1,16 +1,21 @@
 from gymnasium.envs.registration import register
 
 from generals.agents import AgentFactory
+from generals.core.exceptions import GeneralsBotError
 from generals.core.grid import Grid, GridFactory
 from generals.core.replay import Replay
 from generals.envs.pettingzoo_generals import PettingZooGenerals
+from generals.remote.exceptions import GeneralsIOClientError, RegisterAgentError
 
 __all__ = [
     "AgentFactory",
     "GridFactory",
     "PettingZooGenerals",
     "Grid",
     "Replay",
+    "GeneralsBotError",
+    "GeneralsIOClientError",
+    "RegisterAgentError",
 ]
 
 

generals/core/exceptions.py

@@ -0,0 +1,4 @@
+class GeneralsBotError(Exception):
+    """Base generals-bot exception"""
+
+    pass

generals/remote/__init__.py

@@ -1,8 +1,7 @@
-from .generalsio_client import GeneralsBotError, GeneralsIOClient, GeneralsIOClientError, autopilot
+from .generalsio_client import GeneralsIOClient, GeneralsIOClientError, autopilot
 
 __all__ = [
     "autopilot",
-    "GeneralsBotError",
     "GeneralsIOClientError",
     "GeneralsIOClient",
 ]

generals/remote/exceptions.py

@@ -0,0 +1,18 @@
+from generals import GeneralsBotError
+
+
+class GeneralsIOClientError(GeneralsBotError):
+    """Base GeneralsIOClient exception"""
+
+    pass
+
+
+class RegisterAgentError(GeneralsIOClientError):
+    """Registering bot error"""
+
+    def __init__(self, msg: str) -> None:
+        super().__init__()
+        self.msg = msg
+
+    def __str__(self) -> str:
+        return f"Failed to register the agent. Error: {self.msg}"

generals/remote/generalsio_client.py

@@ -6,6 +6,8 @@
 from generals.core.observation import Observation
 from generals.remote.generalsio_state import GeneralsIOstate
 
+from .exceptions import GeneralsIOClientError, RegisterAgentError
+
 DIRECTIONS = [Direction.UP, Direction.DOWN, Direction.LEFT, Direction.RIGHT]
 
 
@@ -24,31 +26,6 @@ def autopilot(agent_id: str, user_id: str, lobby_id: str) -> None:
                 client.join_game()
 
 
-class GeneralsBotError(Exception):
-    """Base generals-bot exception
-    TODO: find a place for exceptions
-    """
-
-    pass
-
-
-class GeneralsIOClientError(GeneralsBotError):
-    """Base GeneralsIOClient exception"""
-
-    pass
-
-
-class RegisterAgentError(GeneralsIOClientError):
-    """Registering bot error"""
-
-    def __init__(self, msg: str) -> None:
-        super().__init__()
-        self.msg = msg
-
-    def __str__(self) -> str:
-        return f"Failed to register the agent. Error: {self.msg}"
-
-
 class GeneralsIOClient(SimpleClient):
     """
     Wrapper around socket.io client to enable Agent to join