Merge branch 'main' into next

Author: actions-user

.github/workflows/pushMain.yml

@@ -1,8 +1,26 @@
 ---
-#---------------------------------------------------------
-# - Create a semantical release
-# - Merge main into next, alpha, beta, and next-major
-#---------------------------------------------------------
+###############################################################################
+# Workflow: Push to main
+#
+# Purpose:
+#   - Automates semantic release creation on pushes to the main branch.
+#   - Merges main into next, alpha, beta, and next-major branches to keep them up to date.
+#
+# Triggers:
+#   - On push to the main branch
+#   - Manual dispatch
+#
+# Key Steps:
+#   1. Checkout repository code
+#   2. Merge main into next, next-major, alpha, and beta branches using a custom action
+#   3. Run semantic-release to publish new versions and changelogs
+#   4. Push updates to the appropriate major version branch if a new release is published
+#
+# Notes:
+#   - Uses a custom merge-branch action for branch synchronization
+#   - Requires PAT (Personal Access Token) secret for authentication
+#   - Integrates with cycjimmy/semantic-release-action for automated releases
+###############################################################################
 name: Push to main
 
 on:

.github/workflows/semanticVersionBump.yml

@@ -1,13 +1,30 @@
 ---
-#------------------------------------------------------------------------------
-# Lawrence McDaniel - https://lawrencemcdaniel.com
-# Version Bump Workflow for Python package openai_utils
+###############################################################################
+# Workflow: Semantic Version Bump (next)
 #
-# Calculate the version of the 'next' branch based on semantic-release rules.
-# Compares the existing value of __version__.py to the calculated value.
-# If they are different, it will update __version__.py and push the changes
-# to the main branch.
-#------------------------------------------------------------------------------
+# Purpose:
+#   - Calculates the next semantic version for the Python package (openai_utils)
+#     based on semantic-release rules, comparing the current __version__.py value
+#     to the calculated value.
+#   - If a version bump is needed, updates __version__.py and pushes the change
+#     to the main branch.
+#
+# Triggers:
+#   - On push to the main branch
+#   - Manual dispatch
+#
+# Key Steps:
+#   1. Checkout repository code
+#   2. Set up Python and Node.js environments
+#   3. Get current and next semantic version values
+#   4. Compare versions and update __version__.py if needed
+#   5. Commit and push the updated version file to the repository
+#
+# Notes:
+#   - Uses semantic-release (dry-run) to determine the next version
+#   - Requires PAT (Personal Access Token) secret for authentication
+#   - Only updates __version__.py if a version bump is detected
+###############################################################################
 name: Semantic Version Bump (next)
 
 on:

.github/workflows/testsPython.yml

@@ -1,23 +1,47 @@
+###############################################################################
+# Workflow: Python Unit Tests
+#
+# Purpose:
+#   Runs Python unit tests automatically on pull requests and pushes to main/next.
+#
+# Triggers:
+#   - On push to main or next branches (Python files only)
+#   - On pull requests affecting Python files
+#   - Manual dispatch
+#
+# Key Steps:
+#   1. Checkout repository code
+#   2. Set up Python environment using a custom action
+#   3. Run unit tests and report results
+#
+# Notes:
+#   - secrets are set in https://github.com/smarter-sh/smarter/settings/secrets/actions
+#   - Integrates with Codecov for coverage reporting
+###############################################################################
 name: Python Unit Tests
 
 on:
-  workflow_dispatch:
-  pull_request:
-    paths:
-      - "**.py"
+  workflow_dispatch: # Allows the workflow to be manually triggered from the GitHub Actions tab
+  pull_request: #
+    paths: # Trigger workflow on pull requests, but
+      - "**.py" # only if Python files are changed
   push:
-    branches:
-      - main
-      - next
-    paths:
-      - "**.py"
+    branches: #
+      - main #
+      - next # Trigger workflow on pushes to main and next
+    paths: # branches, but only if Python files are changed
+      - "**.py" #
 
 env:
   python-version: "3.13"
 
 jobs:
+  # Job #1: Run Python unit tests
+  #
+  # This job will run on an Ubuntu runner and execute the Python
+  # tests by using a custom action located in ./.github/actions/tests/python.
   python-unit-tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest # the runner (remote machine) will use Ubuntu OS
     steps:
       - name: Checkout code
         id: checkout
@@ -37,3 +61,19 @@ jobs:
           mysql-database: "${{ secrets.MYSQL_DATABASE }}"
           mysql-charset: "${{ secrets.MYSQL_CHARSET }}"
           codecov-token: "${{ secrets.CODECOV_TOKEN }}"
+
+  # Job #2: Notifications (Mini-capstone assignment)
+  # This job will run after the Python unit tests and
+  # is scaffolded to facilitate sending notifications based
+  # on the test results.
+  notifications:
+    needs: python-unit-tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify on test results
+        run: |
+          if [ "${{ needs.python-unit-tests.result }}" == "success" ]; then
+            echo "success notifications go here"
+          else
+            echo "failure notifications go here"
+          fi

.pre-commit-config.yaml

@@ -25,13 +25,13 @@ repos:
     hooks:
       - id: isort
         args: ["--settings-path=pyproject.toml"]
-  - repo: local
-    hooks:
-      - id: pylint
-        name: pylint
-        entry: scripts/run_pylint.sh
-        language: script
-        types: [python]
+  # - repo: local
+  #   hooks:
+  #     - id: pylint
+  #       name: pylint
+  #       entry: scripts/run_pylint.sh
+  #       language: script
+  #       types: [python]
   - repo: https://github.com/PyCQA/bandit
     rev: 1.9.4
     hooks:
@@ -43,7 +43,6 @@ repos:
       # See https://pre-commit.com/hooks.html for more hooks
       #- id: check-added-large-files
       - id: fix-byte-order-marker
-      - id: fix-encoding-pragma
       - id: check-case-conflict
       - id: check-json
       - id: check-merge-conflict

app/agent.py

@@ -8,7 +8,6 @@
 from .logging_config import get_logger, setup_logging
 from .prompt import completion
 
-
 setup_logging()
 logger = get_logger(__name__)
 

app/database.py

@@ -17,7 +17,6 @@
     MYSQL_USER,
 )
 
-
 setup_logging()
 logger = get_logger(__name__)
 

app/prompt.py

@@ -25,7 +25,6 @@
 from app.stackademy import stackademy_app
 from app.utils import color_text, dump_json_colored
 
-
 setup_logging()
 logger = get_logger(__name__)
 

app/settings.py

@@ -9,7 +9,6 @@
 from app.const import ToolChoice
 from app.exceptions import ConfigurationException
 
-
 load_dotenv()
 SET_ME_PLEASE = "SET-ME-PLEASE"
 

app/stackademy.py

@@ -13,7 +13,6 @@
 from app.logging_config import get_logger, setup_logging
 from app.utils import color_text
 
-
 setup_logging()
 logger = get_logger(__name__)
 

app/tests/const.py

@@ -7,7 +7,6 @@
 import sys
 from pathlib import Path
 
-
 HERE = os.path.abspath(os.path.dirname(__file__))
 PROJECT_ROOT = str(Path(HERE).parent.parent)
 PYTHON_ROOT = str(Path(PROJECT_ROOT).parent)