Script: "Add Django EOL checker script (comment if <180 days to EOL)"

.github/workflows/test.yml

@@ -69,16 +69,14 @@ jobs:
           MIGRATOR_NAME: MasterUser
           MIGRATOR_PASSWORD: MasterPassword
           APP_USER_NAME: MasterUser
-          APP_USER_PASSWORD: MasterPassword 
-        options:
-          --health-cmd="mariadb-admin ping" --health-interval=5s
+          APP_USER_PASSWORD: MasterPassword
+        options: --health-cmd="mariadb-admin ping" --health-interval=5s
           --health-timeout=2s --health-retries=3
       redis:
         image: redis:latest
         ports:
           - 6379
 
-
     steps:
       - uses: actions/checkout@v4
 
@@ -98,8 +96,7 @@ jobs:
       - name:
           Patch Specify datamodel (Sam, you made the Attachment.origFilename too
           long)
-        run:
-          sed -i 's/name="origFilename"
+        run: sed -i 's/name="origFilename"
           type="java.lang.String"/name="origFilename" type="text"/'
           ./Specify6/config/specify_datamodel.xml
 
@@ -135,10 +132,9 @@ jobs:
           echo "APP_USER_PASSWORD = 'MasterPassword'" >> specifyweb/settings/local_specify_settings.py
           echo "REDIS_HOST = '127.0.0.1'" >> specifyweb/settings/local_specify_settings.py
           echo "REDIS_PORT = ${{ job.services.redis.ports[6379] }}" >> specifyweb/settings/local_specify_settings.py
-      
+
       - name: Need these files to be present
-        run:
-          make specifyweb/settings/build_version.py
+        run: make specifyweb/settings/build_version.py
           specifyweb/settings/secret_key.py
 
       - name: Verify MariaDB connection
@@ -148,7 +144,7 @@ jobs:
           while ! mysqladmin ping -h"127.0.0.1" -P"$PORT" --silent; do
             sleep 1
           done
-      
+
       - name: Run Mypy type checker
         run: VIRTUAL_ENV=./ve make typecheck
 
@@ -180,7 +176,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version-file: specifyweb/frontend/js_src/package.json
-          cache: 'npm'
+          cache: "npm"
           cache-dependency-path: specifyweb/frontend/js_src/package-lock.json
 
       - name: Build frontend
@@ -199,8 +195,7 @@ jobs:
 
       - name: Clone branch that stores localization strings
         # Listen for changes to production branch
-        if:
-          github.ref == format('refs/heads/{0}',
+        if: github.ref == format('refs/heads/{0}',
           github.event.repository.default_branch)
         id: weblate
         uses: actions/checkout@v3
@@ -215,8 +210,7 @@ jobs:
           npm run localizationTests -- --emit ../../../weblate-localization/strings
 
       - name: Sync localization strings with Weblate (only on production branch)
-        if:
-          github.ref == format('refs/heads/{0}',
+        if: github.ref == format('refs/heads/{0}',
           github.event.repository.default_branch)
         working-directory: weblate-localization
         run: |
@@ -282,8 +276,7 @@ jobs:
         #  - This would have already run on the feature branch by the time code
         #    is pushed into production.
         #  - There shouldn't be many direct pushes to production anyway
-        if:
-          github.ref != format('refs/heads/{0}',
+        if: github.ref != format('refs/heads/{0}',
           github.event.repository.default_branch)
         working-directory: specifyweb/frontend/js_src
         run: |
@@ -322,4 +315,132 @@ jobs:
               -m 'Lint code with ESLint and Prettier' \
               -m "Triggered by ${{ github.sha }} on branch ${{ github.ref }}"
             git push
-          fi
+          fi
+
+  eol-check:
+    name: Check dependency EOL
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    timeout-minutes: 10
+
+    permissions:
+      pull-requests: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests
+
+      - name: Run EOL check
+        id: eol
+        run: |
+          output=$(python -m scripts.eol.check_eol || true)
+
+          echo "$output"
+
+          echo "$output" > eol-output.txt
+
+          {
+            echo "output<<EOF"
+            echo "$output"
+            echo "EOF"
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Upload EOL results
+        uses: actions/upload-artifact@v4
+        with:
+          name: eol-results
+          path: eol-output.txt
+
+  eol-comment:
+    name: Consolidated EOL comment
+    runs-on: ubuntu-latest
+    needs: eol-check
+
+    if: github.event_name == 'pull_request'
+
+    permissions:
+      pull-requests: write
+      contents: read
+
+    steps:
+      - name: Download EOL artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+      - name: Combine warnings
+        id: combine
+        shell: bash
+        run: |
+          combined=""
+
+          while IFS= read -r -d '' file; do
+            if grep -q '^STATUS=WARNING' "$file"; then
+              combined="${combined}
+          $(cat "$file")
+          "
+                    fi
+                  done < <(find artifacts -name '*.txt' -print0)
+
+                  {
+                    echo "warnings<<EOF"
+                    echo "$combined"
+                    echo "EOF"
+                  } >> "$GITHUB_OUTPUT"
+
+      - name: Create or update PR comment
+        if: steps.combine.outputs.warnings != ''
+        uses: actions/github-script@v7
+        env:
+          WARNINGS: ${{ steps.combine.outputs.warnings }}
+        with:
+          script: |
+            const warnings = process.env.WARNINGS || '';
+
+            const marker = '<!-- consolidated-eol-warning -->';
+
+            const body =
+              marker + '\n' +
+              '# Dependency EOL Warnings\n\n' +
+              '```text\n' +
+              warnings.replace(/```/g, '``\\`') +
+              '\n```\n\n' +
+              'One or more dependencies are approaching or past End-of-Life.\n' +
+              'Please plan upgrades accordingly.';
+
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+
+            const existingComment = comments.find(comment =>
+              comment.user.type === 'Bot' &&
+              comment.body.includes(marker)
+            );
+
+            if (existingComment) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: existingComment.id,
+                body
+              });
+            } else {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body
+              });
+            }

scripts/eol/check_eol.py

@@ -0,0 +1,11 @@
+import sys
+
+from scripts.eol.runner import run_all
+
+
+if __name__ == "__main__":
+    if len(sys.argv) == 1:
+        run_all()
+    else:
+        from scripts.eol.runner import run_one
+        run_one(sys.argv[1].lower())

scripts/eol/eol_api.py

@@ -0,0 +1,32 @@
+import requests
+import datetime
+import sys
+from requests import RequestException
+
+
+def get_eol_date(api_url: str, cycle: str):
+    try:
+        response = requests.get(api_url, timeout=10)
+        response.raise_for_status()
+    except RequestException as exc:
+        print(f"ERROR: Failed to fetch EOL data: {exc}")
+        sys.exit(1)
+
+    for release in response.json():
+        if str(release["cycle"]) == cycle:
+            return release["eol"]
+
+    print(f"ERROR: No EOL data found for cycle {cycle}")
+    sys.exit(1)
+
+
+def calculate_days_remaining(eol_date: str):
+    if not isinstance(eol_date, str) or not eol_date or eol_date is False:
+        return None
+
+    try:
+        today = datetime.date.today()
+        eol = datetime.datetime.strptime(eol_date, "%Y-%m-%d").date()
+        return (eol - today).days
+    except ValueError:
+        return None

scripts/eol/runner.py

@@ -0,0 +1,43 @@
+from scripts.eol.scanner import scan_repo
+from scripts.eol.runtimes import RUNTIMES
+from scripts.eol.eol_api import get_eol_date, calculate_days_remaining
+
+THRESHOLD_DAYS = 180
+
+
+def run_one(product):
+    run_all(filter_product=product)
+
+
+def run_all(filter_product=None):
+    detected = scan_repo()
+
+    if filter_product:
+        detected = {filter_product: detected.get(filter_product)}
+
+    for name, version in detected.items():
+        if not version:
+            continue
+
+        runtime = RUNTIMES.get(name)
+        if not runtime:
+            continue
+
+        eol_date = get_eol_date(runtime.api, version)
+        days = calculate_days_remaining(eol_date)
+
+        if days is None:
+            status = "UNKNOWN"
+        else:
+            status = "WARNING" if days < THRESHOLD_DAYS else "OK"
+
+        print(f"STATUS={status}")
+        print(f"{name.upper()}_VERSION={version}")
+        print(f"{name.upper()}_CYCLE={version}")
+        print(f"EOL_DATE={eol_date}")
+        print(f"DAYS_REMAINING={days}")
+
+        print(f"\n--- {runtime.display_name} ---")
+        print(f"Version: {version}")
+        print(f"EOL: {eol_date}")
+        print(f"Status: {status}\n")

scripts/eol/runtimes.py

@@ -0,0 +1,24 @@
+class Runtime:
+    def __init__(self, name, api, display_name):
+        self.name = name
+        self.api = api
+        self.display_name = display_name
+
+
+RUNTIMES = {
+    "python": Runtime(
+        "python",
+        "https://endoflife.date/api/python.json",
+        "Python",
+    ),
+    "node": Runtime(
+        "node",
+        "https://endoflife.date/api/nodejs.json",
+        "Node.js",
+    ),
+    "django": Runtime(
+        "django",
+        "https://endoflife.date/api/django.json",
+        "Django",
+    ),
+}