feat: Added automatic README.md updater for supported Python versions

Author: jakub-kocka

.github/workflows/update-readme.yml

@@ -0,0 +1,102 @@
+name: Update README with supported versions
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'  # Weekly on Monday at 6 AM UTC (after main builds)
+  workflow_run:
+    workflows: ["platforms-dispatches"]
+    types: [completed]
+    branches: [main]
+
+jobs:
+  update-readme:
+    name: Update README with current supported versions
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install requests python-dateutil
+
+      - name: Generate supported versions
+        id: generate
+        run: |
+          python supported_versions.py ${{ secrets.IDF_VERSIONS_TXT }}
+          # Capture the supported Python versions for PR description
+          PYTHON_VERSIONS=$(jq -c '.supported_python' supported_versions.json)
+          echo "supported_python=$PYTHON_VERSIONS" >> $GITHUB_OUTPUT
+
+      - name: Update README with supported Python versions
+        run: |
+          python update_readme_versions.py
+
+      - name: Check for changes
+        id: changes
+        run: |
+          if git diff --quiet README.md; then
+            echo "has_changes=false" >> $GITHUB_OUTPUT
+            echo "No changes detected in README.md"
+          else
+            echo "has_changes=true" >> $GITHUB_OUTPUT
+            echo "Changes detected in README.md"
+            git diff README.md
+          fi
+
+      - name: Create Pull Request
+        if: steps.changes.outputs.has_changes == 'true'
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: |
+            Update README with current supported Python versions
+
+            Auto-updated by update-readme workflow based on current ESP-IDF and Python support lifecycle.
+
+            Changes:
+            - Updated supported Python versions in README.md based on dynamic version detection
+            - Python versions are determined by ESP-IDF lifecycle and Python EOL dates
+          title: "📝 Update README with current supported Python versions"
+          body: |
+            ## Summary
+            This PR automatically updates the README.md with the current supported Python versions based on our dynamic version detection system.
+
+            ## Changes Made
+            - ✅ Updated "Supported Python versions" section in README.md
+            - 🔄 Based on ESP-IDF lifecycle and Python EOL dates
+            - 🤖 Generated by automated workflow
+
+            ## Python Versions Updated
+            The following Python versions are currently supported:
+            ```
+            ${{ steps.generate.outputs.supported_python }}
+            ```
+
+            ## Verification
+            - [ ] Python versions match our build matrix
+            - [ ] No other sections of README were modified
+            - [ ] All supported versions are actively maintained
+
+            ---
+
+            > **Note**: This PR was automatically created by the [update-readme workflow](.github/workflows/update-readme.yml).
+            > The Python versions are dynamically determined based on ESP-IDF support lifecycle.
+          branch: update/readme-python-versions
+          delete-branch: true
+          assignees: ${{ github.actor }}
+          reviewers: jakub-kocka
+          labels: |
+            documentation
+            automated
+            python-versions

update_readme_versions.py

@@ -0,0 +1,52 @@
+# SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+"""
+Script to update README.md with dynamically detected supported Python versions.
+"""
+import json
+import re
+import sys
+
+def update_readme_python_versions():
+    """Update the Python versions section in README.md based on supported_versions.json"""
+
+    try:
+        with open('supported_versions.json', 'r') as f:
+            versions_data = json.load(f)
+    except FileNotFoundError:
+        sys.exit('Error: supported_versions.json not found. Run supported_versions.py first.')
+
+    supported_python = versions_data.get('supported_python', [])
+    if not supported_python:
+        sys.exit('Error: No supported Python versions found in JSON.')
+
+    try:
+        with open('README.md', 'r') as f:
+            readme_content = f.read()
+    except FileNotFoundError:
+        sys.exit('Error: README.md not found.')
+
+    new_python_section = []
+    for version in supported_python:
+        new_python_section.append(f'* {version}')
+    new_python_lines = '\n'.join(new_python_section)
+
+    # Use regex to find and replace the Python versions section
+    # Pattern: "Supported Python versions:" followed by lines starting with "* " until next section
+    pattern = r'(Supported Python versions:\n)((?:\* \d+\.\d+\n)*)'
+    replacement = f'\\1{new_python_lines}\n'
+
+    new_readme = re.sub(pattern, replacement, readme_content)
+
+    if new_readme == readme_content:
+        print('ℹ️  No changes needed - Python versions are already up to date.')
+        return False
+
+    with open('README.md', 'w') as f:
+        f.write(new_readme)
+
+    print(f"✅ Updated README.md with supported Python versions: {', '.join(supported_python)}")
+    return True
+
+
+update_readme_python_versions()