Merge pull request #333 from rHomelab/chore/requirements_rework

Author: tigattack

.github/actions/setup/action.yml

@@ -13,9 +13,9 @@ runs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ steps.find_pyver.outputs.python-version }}
-    - name: Install base dependencies
+    - name: Install cog dependencies
       shell: bash
       run: pip install --quiet --upgrade --requirement requirements.txt
-    - name: Install CI & cog dependencies
+    - name: Install CI dependencies
       shell: bash
       run: pip install --quiet --upgrade --requirement requirements-dev.txt

.github/compile_cog_requirements.py

@@ -0,0 +1,29 @@
+"""Pipeline script for extracting imports from cogs"""
+
+import json
+from glob import glob
+
+
+def fetch_requirements() -> tuple[set[str], int]:
+    requirements = set()
+    cogs_with_requirements = 0
+
+    for filename in glob("*/info.json"):
+        with open(filename, "r") as fp:
+            info = json.load(fp)
+        if "requirements" in info:
+            requirements.update(info["requirements"])
+            cogs_with_requirements += 1
+
+    return requirements, cogs_with_requirements
+
+
+def write_requirements(requirements: set[str]):
+    with open("requirements.txt", "w") as fp:
+        fp.write("\n".join(sorted(requirements)) + "\n")
+
+
+if __name__ == "__main__":
+    all_requirements, cog_count = fetch_requirements()
+    write_requirements(all_requirements)
+    print(f"Compiled {len(all_requirements)} requirements from {cog_count} cogs")

.github/workflows/compile-requirements.yml

@@ -0,0 +1,49 @@
+name: Compile Requirements
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "*/info.json"
+      - ".github/compile_cog_requirements.py"
+  pull_request:
+    branches: [main]
+    paths:
+      - "*/info.json"
+      - ".github/compile_cog_requirements.py"
+  workflow_dispatch:
+
+jobs:
+  compile-requirements:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+
+      - name: Compile requirements
+        run: python3 .github/compile_cog_requirements.py
+
+      - name: Check for changes
+        id: check_changes
+        run: |
+          if git diff --quiet requirements.txt; then
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit and push changes
+        if: steps.check_changes.outputs.changed == 'true'
+        run: |
+          git config --local user.name 'github-actions[bot]'
+          git config --local user.email 'github-actions[bot]@users.noreply.github.com'
+          git add requirements.txt
+          git commit -m "chore: update cog requirements.txt"
+          git push

guild_profiles/info.json

@@ -9,7 +9,7 @@
         "utility"
     ],
     "requirements": [
-        "aiofiles>=24.1.0"
+        "aiofiles~=24.1.0"
     ],
     "install_msg": "Usage: `[p]guildprofile`",
     "min_bot_version": "3.5.1"

jail/info.json

@@ -6,7 +6,7 @@
     "description": "Create individual jails for users when multiple users need to be timed out.",
     "disabled": false,
     "name": "jail",
-    "requirements": ["chat_exporter>=2.8.1"],
+    "requirements": ["chat_exporter~=2.8.1"],
     "tags": [
         "utility"
     ],

prometheus_exporter/info.json

@@ -11,6 +11,6 @@
         "prom"
     ],
     "min_bot_version": "3.5.1",
-    "requirements": ["prometheus_client"],
+    "requirements": ["prometheus-client~=0.22.1"],
     "install_msg": "Usage: `[p]prom_export`"
 }

purge/info.json

@@ -11,7 +11,7 @@
         "inactive"
     ],
     "requirements": [
-        "croniter>=6.0.0"
+        "croniter~=6.0.0"
     ],
     "install_msg": "Usage: `[p]purge`",
     "min_bot_version": "3.5.1"

requirements-dev.txt

@@ -1,13 +1,10 @@
-aiofiles>=24.1.0
-chat_exporter>=2.8.1
-croniter>=6.0.0
-fastjsonschema==2.19.1
-pre-commit==3.7.0
-prometheus-client
-pyright==1.1.394
-pytest-aiohttp==1.0.5
-pytest-asyncio==0.23.6
-pytest==8.2.0
-python-Levenshtein>=0.27.1
-ruff==0.9.6
-sentry-sdk>=2.22.0
+Red-DiscordBot>=3.5.0
+
+pyright~=1.1.394
+ruff~=0.12.0
+
+fastjsonschema~=2.19.1
+pre-commit~=3.7.0
+pytest-aiohttp~=1.0.5
+pytest-asyncio~=0.23.6
+pytest~=8.2.0

requirements.txt

@@ -1,3 +1,6 @@
-pip
-wheel
-Red-DiscordBot
+aiofiles~=24.1.0
+chat_exporter~=2.8.1
+croniter~=6.0.0
+prometheus-client~=0.22.1
+python-Levenshtein~=0.27.1
+sentry-sdk~=2.22.0

sentry/info.json

@@ -10,7 +10,7 @@
         "sentry"
     ],
     "requirements": [
-        "sentry-sdk>=2.22.0"
+        "sentry-sdk~=2.22.0"
     ],
     "install_msg": "Install: `[p]set api sentry dsn,https://fooo@bar.baz/9`",
     "min_bot_version": "3.5.1"